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 { removeHLSFileObjectStorage, 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/model-cache'
36 import { buildVideoEmbedPath, buildVideoWatchPath, pick } from '@shared/core-utils'
37 import { ffprobePromise, getAudioStream, 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 { setAsUpdated } from '../shared'
107 import { UserModel } from '../user/user'
108 import { UserVideoHistoryModel } from '../user/user-video-history'
109 import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils'
110 import { VideoViewModel } from '../view/video-view'
112 videoFilesModelToFormattedJSON,
113 VideoFormattingJSONOptions,
114 videoModelToActivityPubObject,
115 videoModelToFormattedDetailsJSON,
116 videoModelToFormattedJSON
117 } from './formatter/video-format-utils'
118 import { ScheduleVideoUpdateModel } from './schedule-video-update'
120 BuildVideosListQueryOptions,
121 DisplayOnlyForFollowerOptions,
122 VideoModelGetQueryBuilder,
123 VideosIdListQueryBuilder,
124 VideosModelListQueryBuilder
126 import { TagModel } from './tag'
127 import { ThumbnailModel } from './thumbnail'
128 import { VideoBlacklistModel } from './video-blacklist'
129 import { VideoCaptionModel } from './video-caption'
130 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
131 import { VideoCommentModel } from './video-comment'
132 import { VideoFileModel } from './video-file'
133 import { VideoImportModel } from './video-import'
134 import { VideoJobInfoModel } from './video-job-info'
135 import { VideoLiveModel } from './video-live'
136 import { VideoPlaylistElementModel } from './video-playlist-element'
137 import { VideoShareModel } from './video-share'
138 import { VideoSourceModel } from './video-source'
139 import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
140 import { VideoTagModel } from './video-tag'
142 export enum ScopeNames {
144 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
145 WITH_TAGS = 'WITH_TAGS',
146 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
147 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
148 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
149 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
150 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
151 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
152 WITH_THUMBNAILS = 'WITH_THUMBNAILS'
155 export type ForAPIOptions = {
158 videoPlaylistId?: number
160 withAccountBlockerIds?: number[]
164 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
165 attributes: [ 'id', 'url', 'uuid', 'remote' ]
167 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
168 const include: Includeable[] = [
170 model: VideoChannelModel.scope({
172 VideoChannelScopeNames.SUMMARY, {
174 withAccountBlockerIds: options.withAccountBlockerIds
181 attributes: [ 'type', 'filename' ],
182 model: ThumbnailModel,
187 const query: FindOptions = {}
197 if (options.videoPlaylistId) {
199 model: VideoPlaylistElementModel.unscoped(),
202 videoPlaylistId: options.videoPlaylistId
207 query.include = include
211 [ScopeNames.WITH_THUMBNAILS]: {
214 model: ThumbnailModel,
219 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
222 model: VideoChannelModel.unscoped(),
227 exclude: [ 'privateKey', 'publicKey' ]
229 model: ActorModel.unscoped(),
233 attributes: [ 'host' ],
234 model: ServerModel.unscoped(),
238 model: ActorImageModel,
245 model: AccountModel.unscoped(),
249 model: ActorModel.unscoped(),
251 exclude: [ 'privateKey', 'publicKey' ]
256 attributes: [ 'host' ],
257 model: ServerModel.unscoped(),
261 model: ActorImageModel,
273 [ScopeNames.WITH_TAGS]: {
274 include: [ TagModel ]
276 [ScopeNames.WITH_BLACKLISTED]: {
279 attributes: [ 'id', 'reason', 'unfederated' ],
280 model: VideoBlacklistModel,
285 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
286 let subInclude: any[] = []
288 if (withRedundancies === true) {
291 attributes: [ 'fileUrl' ],
292 model: VideoRedundancyModel.unscoped(),
301 model: VideoFileModel,
309 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
310 const subInclude: IncludeOptions[] = [
312 model: VideoFileModel,
317 if (withRedundancies === true) {
319 attributes: [ 'fileUrl' ],
320 model: VideoRedundancyModel.unscoped(),
328 model: VideoStreamingPlaylistModel.unscoped(),
336 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
339 model: ScheduleVideoUpdateModel.unscoped(),
344 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
348 attributes: [ 'currentTime' ],
349 model: UserVideoHistoryModel.unscoped(),
362 buildTrigramSearchIndex('video_name_trigram', 'name'),
364 { fields: [ 'createdAt' ] },
367 { name: 'publishedAt', order: 'DESC' },
368 { name: 'id', order: 'ASC' }
371 { fields: [ 'duration' ] },
374 { name: 'views', order: 'DESC' },
375 { name: 'id', order: 'ASC' }
378 { fields: [ 'channelId' ] },
380 fields: [ 'originallyPublishedAt' ],
382 originallyPublishedAt: {
388 fields: [ 'category' ], // We don't care videos with an unknown category
396 fields: [ 'licence' ], // We don't care videos with an unknown licence
404 fields: [ 'language' ], // We don't care videos with an unknown language
412 fields: [ 'nsfw' ], // Most of the videos are not NSFW
418 fields: [ 'remote' ], // Only index local videos
433 export class VideoModel extends Model<Partial<AttributesOnly<VideoModel>>> {
436 @Default(DataType.UUIDV4)
438 @Column(DataType.UUID)
442 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
458 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
462 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
464 privacy: VideoPrivacy
467 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
473 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
474 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
479 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
480 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
484 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
519 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
520 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
525 commentsEnabled: boolean
529 downloadEnabled: boolean
533 waitTranscoding: boolean
537 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
548 @Default(DataType.NOW)
555 originallyPublishedAt: Date
557 @ForeignKey(() => VideoChannelModel)
561 @BelongsTo(() => VideoChannelModel, {
567 VideoChannel: VideoChannelModel
569 @BelongsToMany(() => TagModel, {
570 foreignKey: 'videoId',
571 through: () => VideoTagModel,
576 @BelongsToMany(() => TrackerModel, {
577 foreignKey: 'videoId',
578 through: () => VideoTrackerModel,
581 Trackers: TrackerModel[]
583 @HasMany(() => ThumbnailModel, {
591 Thumbnails: ThumbnailModel[]
593 @HasMany(() => VideoPlaylistElementModel, {
600 VideoPlaylistElements: VideoPlaylistElementModel[]
602 @HasOne(() => VideoSourceModel, {
609 VideoSource: VideoSourceModel
611 @HasMany(() => VideoAbuseModel, {
618 VideoAbuses: VideoAbuseModel[]
620 @HasMany(() => VideoFileModel, {
628 VideoFiles: VideoFileModel[]
630 @HasMany(() => VideoStreamingPlaylistModel, {
638 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
640 @HasMany(() => VideoShareModel, {
647 VideoShares: VideoShareModel[]
649 @HasMany(() => AccountVideoRateModel, {
656 AccountVideoRates: AccountVideoRateModel[]
658 @HasMany(() => VideoCommentModel, {
666 VideoComments: VideoCommentModel[]
668 @HasMany(() => VideoViewModel, {
675 VideoViews: VideoViewModel[]
677 @HasMany(() => UserVideoHistoryModel, {
684 UserVideoHistories: UserVideoHistoryModel[]
686 @HasOne(() => ScheduleVideoUpdateModel, {
693 ScheduleVideoUpdate: ScheduleVideoUpdateModel
695 @HasOne(() => VideoBlacklistModel, {
702 VideoBlacklist: VideoBlacklistModel
704 @HasOne(() => VideoLiveModel, {
711 VideoLive: VideoLiveModel
713 @HasOne(() => VideoImportModel, {
720 VideoImport: VideoImportModel
722 @HasMany(() => VideoCaptionModel, {
729 ['separate' as any]: true
731 VideoCaptions: VideoCaptionModel[]
733 @HasOne(() => VideoJobInfoModel, {
740 VideoJobInfo: VideoJobInfoModel
743 static async sendDelete (instance: MVideoAccountLight, options) {
744 if (!instance.isOwned()) return undefined
746 // Lazy load channels
747 if (!instance.VideoChannel) {
748 instance.VideoChannel = await instance.$get('VideoChannel', {
753 transaction: options.transaction
754 }) as MChannelAccountDefault
757 return sendDeleteVideo(instance, options.transaction)
761 static async removeFiles (instance: VideoModel, options) {
762 const tasks: Promise<any>[] = []
764 logger.info('Removing files of video %s.', instance.url)
766 if (instance.isOwned()) {
767 if (!Array.isArray(instance.VideoFiles)) {
768 instance.VideoFiles = await instance.$get('VideoFiles', { transaction: options.transaction })
771 // Remove physical files and torrents
772 instance.VideoFiles.forEach(file => {
773 tasks.push(instance.removeWebTorrentFile(file))
776 // Remove playlists file
777 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
778 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists', { transaction: options.transaction })
781 for (const p of instance.VideoStreamingPlaylists) {
782 tasks.push(instance.removeStreamingPlaylistFiles(p))
786 // Do not wait video deletion because we could be in a transaction
789 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
796 static stopLiveIfNeeded (instance: VideoModel) {
797 if (!instance.isLive) return
799 logger.info('Stopping live of video %s after video deletion.', instance.uuid)
801 LiveManager.Instance.stopSessionOf(instance.id, null)
805 static invalidateCache (instance: VideoModel) {
806 ModelCache.Instance.invalidateCache('video', instance.id)
810 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
811 const tasks: Promise<any>[] = []
813 if (!Array.isArray(instance.VideoAbuses)) {
814 instance.VideoAbuses = await instance.$get('VideoAbuses', { transaction: options.transaction })
816 if (instance.VideoAbuses.length === 0) return undefined
819 logger.info('Saving video abuses details of video %s.', instance.url)
821 if (!instance.Trackers) instance.Trackers = await instance.$get('Trackers', { transaction: options.transaction })
822 const details = instance.toFormattedDetailsJSON()
824 for (const abuse of instance.VideoAbuses) {
825 abuse.deletedVideo = details
826 tasks.push(abuse.save({ transaction: options.transaction }))
829 await Promise.all(tasks)
832 static listLocalIds (): Promise<number[]> {
834 attributes: [ 'id' ],
841 return VideoModel.findAll(query)
842 .then(rows => rows.map(r => r.id))
845 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
846 function getRawQuery (select: string) {
847 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
848 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
849 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
850 'WHERE "Account"."actorId" = ' + actorId
851 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
852 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
853 'WHERE "VideoShare"."actorId" = ' + actorId
855 return `(${queryVideo}) UNION (${queryVideoShare})`
858 const rawQuery = getRawQuery('"Video"."id"')
859 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
865 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ]),
868 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
870 [Op.or]: getPrivaciesForFederation()
874 attributes: [ 'filename', 'language', 'fileUrl' ],
875 model: VideoCaptionModel.unscoped(),
879 attributes: [ 'id', 'url' ],
880 model: VideoShareModel.unscoped(),
882 // We only want videos shared by this actor
897 attributes: [ 'id', 'url' ],
898 model: ActorModel.unscoped()
903 model: VideoChannelModel.unscoped(),
907 attributes: [ 'name' ],
908 model: AccountModel.unscoped(),
912 attributes: [ 'id', 'url', 'followersUrl' ],
913 model: ActorModel.unscoped(),
919 attributes: [ 'id', 'url', 'followersUrl' ],
920 model: ActorModel.unscoped(),
926 model: VideoStreamingPlaylistModel.unscoped(),
930 model: VideoFileModel,
935 VideoLiveModel.unscoped(),
941 return Bluebird.all([
942 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
943 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
944 ]).then(([ rows, totals ]) => {
945 // totals: totalVideos + totalVideoShares
947 let totalVideoShares = 0
948 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
949 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
951 const total = totalVideos + totalVideoShares
959 static async listPublishedLiveUUIDs () {
961 attributes: [ 'uuid' ],
965 state: VideoState.PUBLISHED
969 const result = await VideoModel.findAll(options)
971 return result.map(v => v.uuid)
974 static listUserVideosForApi (options: {
984 const { accountId, channelId, start, count, sort, search, isLive } = options
986 function buildBaseQuery (forCount: boolean): FindOptions {
987 const where: WhereOptions = {}
991 [Op.iLike]: '%' + search + '%'
995 if (exists(isLive)) {
996 where.isLive = isLive
999 const channelWhere = channelId
1007 order: getVideoSort(sort),
1011 ? VideoChannelModel.unscoped()
1012 : VideoChannelModel,
1014 where: channelWhere,
1018 ? AccountModel.unscoped()
1033 const countQuery = buildBaseQuery(true)
1034 const findQuery = buildBaseQuery(false)
1036 const findScopes: (string | ScopeOptions)[] = [
1037 ScopeNames.WITH_SCHEDULED_UPDATE,
1038 ScopeNames.WITH_BLACKLISTED,
1039 ScopeNames.WITH_THUMBNAILS
1042 return Promise.all([
1043 VideoModel.count(countQuery),
1044 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
1045 ]).then(([ count, rows ]) => {
1053 static async listForApi (options: {
1061 include?: VideoInclude
1063 hasFiles?: boolean // default false
1064 hasWebtorrentFiles?: boolean
1065 hasHLSFiles?: boolean
1067 categoryOneOf?: number[]
1068 licenceOneOf?: number[]
1069 languageOneOf?: string[]
1070 tagsOneOf?: string[]
1071 tagsAllOf?: string[]
1072 privacyOneOf?: VideoPrivacy[]
1075 videoChannelId?: number
1077 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1079 videoPlaylistId?: number
1081 trendingDays?: number
1083 user?: MUserAccountId
1084 historyOfUser?: MUserId
1086 countVideos?: boolean
1090 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1091 VideoModel.throwIfPrivacyOneOfWithoutUser(options.privacyOneOf, options.user)
1093 const trendingDays = options.sort.endsWith('trending')
1094 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1097 let trendingAlgorithm: string
1098 if (options.sort.endsWith('hot')) trendingAlgorithm = 'hot'
1099 if (options.sort.endsWith('best')) trendingAlgorithm = 'best'
1101 const serverActor = await getServerActor()
1103 const queryOptions = {
1118 'displayOnlyForFollower',
1126 'hasWebtorrentFiles',
1130 serverAccountIdForBlock: serverActor.Account.id,
1135 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
1138 static async searchAndPopulateAccountAndServer (options: {
1146 include?: VideoInclude
1148 categoryOneOf?: number[]
1149 licenceOneOf?: number[]
1150 languageOneOf?: string[]
1151 tagsOneOf?: string[]
1152 tagsAllOf?: string[]
1153 privacyOneOf?: VideoPrivacy[]
1155 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1157 user?: MUserAccountId
1159 hasWebtorrentFiles?: boolean
1160 hasHLSFiles?: boolean
1165 startDate?: string // ISO 8601
1166 endDate?: string // ISO 8601
1167 originallyPublishedStartDate?: string
1168 originallyPublishedEndDate?: string
1170 durationMin?: number // seconds
1171 durationMax?: number // seconds
1174 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1175 VideoModel.throwIfPrivacyOneOfWithoutUser(options.privacyOneOf, options.user)
1177 const serverActor = await getServerActor()
1179 const queryOptions = {
1198 'originallyPublishedStartDate',
1199 'originallyPublishedEndDate',
1203 'hasWebtorrentFiles',
1206 'displayOnlyForFollower'
1208 serverAccountIdForBlock: serverActor.Account.id
1211 return VideoModel.getAvailableForApi(queryOptions)
1214 static countLives (options: {
1216 mode: 'published' | 'not-ended'
1220 remote: options.remote,
1222 state: options.mode === 'not-ended'
1223 ? { [Op.ne]: VideoState.LIVE_ENDED }
1224 : { [Op.eq]: VideoState.PUBLISHED }
1228 return VideoModel.count(query)
1231 static countVideosUploadedByUserSince (userId: number, since: Date) {
1235 model: VideoChannelModel.unscoped(),
1239 model: AccountModel.unscoped(),
1243 model: UserModel.unscoped(),
1261 return VideoModel.unscoped().count(options)
1264 static countLivesOfAccount (accountId: number) {
1270 [Op.ne]: VideoState.LIVE_ENDED
1276 model: VideoChannelModel.unscoped(),
1284 return VideoModel.count(options)
1287 static load (id: number | string, transaction?: Transaction): Promise<MVideoThumbnail> {
1288 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1290 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails' })
1293 static loadWithBlacklist (id: number | string, transaction?: Transaction): Promise<MVideoThumbnailBlacklist> {
1294 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1296 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails-blacklist' })
1299 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
1302 where: buildWhereIdOrUUID(id),
1306 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1309 return ModelCache.Instance.doCache({
1310 cacheType: 'load-video-immutable-id',
1317 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
1319 const query: FindOptions = {
1326 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1329 return ModelCache.Instance.doCache({
1330 cacheType: 'load-video-immutable-url',
1337 static loadOnlyId (id: number | string, transaction?: Transaction): Promise<MVideoId> {
1338 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1340 return queryBuilder.queryVideo({ id, transaction, type: 'id' })
1343 static loadWithFiles (id: number | string, transaction?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
1344 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1346 return queryBuilder.queryVideo({ id, transaction, type: 'all-files', logging })
1349 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
1350 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1352 return queryBuilder.queryVideo({ url, transaction, type: 'thumbnails' })
1355 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
1356 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1358 return queryBuilder.queryVideo({ url, transaction, type: 'account-blacklist-files' })
1361 static loadFull (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
1362 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1364 return queryBuilder.queryVideo({ id, transaction: t, type: 'full', userId })
1367 static loadForGetAPI (parameters: {
1369 transaction?: Transaction
1371 }): Promise<MVideoDetails> {
1372 const { id, transaction, userId } = parameters
1373 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1375 return queryBuilder.queryVideo({ id, transaction, type: 'api', userId })
1378 static async getStats () {
1379 const serverActor = await getServerActor()
1381 let totalLocalVideoViews = await VideoModel.sum('views', {
1387 // Sequelize could return null...
1388 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1390 const baseOptions = {
1393 sort: '-publishedAt',
1395 displayOnlyForFollower: {
1396 actorId: serverActor.id,
1401 const { total: totalLocalVideos } = await VideoModel.listForApi({
1407 const { total: totalVideos } = await VideoModel.listForApi(baseOptions)
1411 totalLocalVideoViews,
1416 static incrementViews (id: number, views: number) {
1417 return VideoModel.increment('views', {
1425 static updateRatesOf (videoId: number, type: VideoRateType, count: number, t: Transaction) {
1426 const field = type === 'like'
1430 const rawQuery = `UPDATE "video" SET "${field}" = :count WHERE "video"."id" = :videoId`
1432 return AccountVideoRateModel.sequelize.query(rawQuery, {
1434 replacements: { videoId, rateType: type, count },
1435 type: QueryTypes.UPDATE
1439 static syncLocalRates (videoId: number, type: VideoRateType, t: Transaction) {
1440 const field = type === 'like'
1444 const rawQuery = `UPDATE "video" SET "${field}" = ` +
1446 'SELECT COUNT(id) FROM "accountVideoRate" WHERE "accountVideoRate"."videoId" = "video"."id" AND type = :rateType' +
1448 'WHERE "video"."id" = :videoId'
1450 return AccountVideoRateModel.sequelize.query(rawQuery, {
1452 replacements: { videoId, rateType: type },
1453 type: QueryTypes.UPDATE
1457 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1458 // Instances only share videos
1459 const query = 'SELECT 1 FROM "videoShare" ' +
1460 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1461 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1465 type: QueryTypes.SELECT as QueryTypes.SELECT,
1466 bind: { followerActorId, videoId },
1470 return VideoModel.sequelize.query(query, options)
1471 .then(results => results.length === 1)
1474 static bulkUpdateSupportField (ofChannel: MChannel, t: Transaction) {
1477 channelId: ofChannel.id
1482 return VideoModel.update({ support: ofChannel.support }, options)
1485 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
1487 attributes: [ 'id' ],
1489 channelId: videoChannel.id
1493 return VideoModel.findAll(query)
1494 .then(videos => videos.map(v => v.id))
1497 // threshold corresponds to how many video the field should have to be returned
1498 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1499 const serverActor = await getServerActor()
1501 const queryOptions: BuildVideosListQueryOptions = {
1502 attributes: [ `"${field}"` ],
1503 group: `GROUP BY "${field}"`,
1504 having: `HAVING COUNT("${field}") >= ${threshold}`,
1508 serverAccountIdForBlock: serverActor.Account.id,
1509 displayOnlyForFollower: {
1510 actorId: serverActor.id,
1515 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1517 return queryBuilder.queryVideoIds(queryOptions)
1518 .then(rows => rows.map(r => r[field]))
1521 static buildTrendingQuery (trendingDays: number) {
1525 model: VideoViewModel,
1530 [Op.gte as any]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1536 private static async getAvailableForApi (
1537 options: BuildVideosListQueryOptions,
1539 ): Promise<ResultList<VideoModel>> {
1540 const span = tracer.startSpan('peertube.VideoModel.getAvailableForApi')
1542 function getCount () {
1543 if (countVideos !== true) return Promise.resolve(undefined)
1545 const countOptions = Object.assign({}, options, { isCount: true })
1546 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1548 return queryBuilder.countVideoIds(countOptions)
1551 function getModels () {
1552 if (options.count === 0) return Promise.resolve([])
1554 const queryBuilder = new VideosModelListQueryBuilder(VideoModel.sequelize)
1556 return queryBuilder.queryVideos(options)
1559 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1569 private static throwIfPrivateIncludeWithoutUser (include: VideoInclude, user: MUserAccountId) {
1570 if (VideoModel.isPrivateInclude(include) && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1571 throw new Error('Try to filter all-local but user cannot see all videos')
1575 private static throwIfPrivacyOneOfWithoutUser (privacyOneOf: VideoPrivacy[], user: MUserAccountId) {
1576 if (privacyOneOf && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1577 throw new Error('Try to choose video privacies but user cannot see all videos')
1581 private static isPrivateInclude (include: VideoInclude) {
1582 return include & VideoInclude.BLACKLISTED ||
1583 include & VideoInclude.BLOCKED_OWNER ||
1584 include & VideoInclude.NOT_PUBLISHED_STATE
1588 return !!this.VideoBlacklist
1592 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1595 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1596 const files = this.getAllFiles()
1597 const file = fun(files, file => file.resolution)
1598 if (!file) return undefined
1601 return Object.assign(file, { Video: this })
1604 if (file.videoStreamingPlaylistId) {
1605 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1607 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1610 throw new Error('File is not associated to a video of a playlist')
1613 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1614 return this.getQualityFileBy(maxBy)
1617 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1618 return this.getQualityFileBy(minBy)
1621 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1622 if (Array.isArray(this.VideoFiles) === false) return undefined
1624 const file = this.VideoFiles.find(f => f.resolution === resolution)
1625 if (!file) return undefined
1627 return Object.assign(file, { Video: this })
1630 hasWebTorrentFiles () {
1631 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1634 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction?: Transaction) {
1635 thumbnail.videoId = this.id
1637 const savedThumbnail = await thumbnail.save({ transaction })
1639 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1641 this.Thumbnails = this.Thumbnails.filter(t => t.id !== savedThumbnail.id)
1642 this.Thumbnails.push(savedThumbnail)
1646 if (Array.isArray(this.Thumbnails) === false) return undefined
1648 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1652 return !!this.getPreview()
1656 if (Array.isArray(this.Thumbnails) === false) return undefined
1658 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1662 return this.remote === false
1665 getWatchStaticPath () {
1666 return buildVideoWatchPath({ shortUUID: uuidToShort(this.uuid) })
1669 getEmbedStaticPath () {
1670 return buildVideoEmbedPath(this)
1673 getMiniatureStaticPath () {
1674 const thumbnail = this.getMiniature()
1675 if (!thumbnail) return null
1677 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1680 getPreviewStaticPath () {
1681 const preview = this.getPreview()
1682 if (!preview) return null
1684 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1685 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1688 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1689 return videoModelToFormattedJSON(this, options)
1692 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1693 return videoModelToFormattedDetailsJSON(this)
1696 getFormattedVideoFilesJSON (includeMagnet = true): VideoFile[] {
1697 let files: VideoFile[] = []
1699 if (Array.isArray(this.VideoFiles)) {
1700 const result = videoFilesModelToFormattedJSON(this, this.VideoFiles, { includeMagnet })
1701 files = files.concat(result)
1704 for (const p of (this.VideoStreamingPlaylists || [])) {
1705 const result = videoFilesModelToFormattedJSON(this, p.VideoFiles, { includeMagnet })
1706 files = files.concat(result)
1712 toActivityPubObject (this: MVideoAP): VideoObject {
1713 return videoModelToActivityPubObject(this)
1716 getTruncatedDescription () {
1717 if (!this.description) return null
1719 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1720 return peertubeTruncate(this.description, { length: maxLength })
1724 let files: MVideoFile[] = []
1726 if (Array.isArray(this.VideoFiles)) {
1727 files = files.concat(this.VideoFiles)
1730 if (Array.isArray(this.VideoStreamingPlaylists)) {
1731 for (const p of this.VideoStreamingPlaylists) {
1732 if (Array.isArray(p.VideoFiles)) {
1733 files = files.concat(p.VideoFiles)
1741 probeMaxQualityFile () {
1742 const file = this.getMaxQualityFile()
1743 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1745 return VideoPathManager.Instance.makeAvailableVideoFile(file.withVideoOrPlaylist(videoOrPlaylist), async originalFilePath => {
1746 const probe = await ffprobePromise(originalFilePath)
1748 const { audioStream } = await getAudioStream(originalFilePath, probe)
1753 ...await getVideoStreamDimensionsInfo(originalFilePath, probe)
1758 getDescriptionAPIPath () {
1759 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1762 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1763 if (!this.VideoStreamingPlaylists) return undefined
1765 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1766 if (!playlist) return undefined
1768 return playlist.withVideo(this)
1771 setHLSPlaylist (playlist: MStreamingPlaylist) {
1772 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1774 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1775 this.VideoStreamingPlaylists = toAdd
1779 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1780 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1784 removeWebTorrentFile (videoFile: MVideoFile, isRedundancy = false) {
1785 const filePath = isRedundancy
1786 ? VideoPathManager.Instance.getFSRedundancyVideoFilePath(this, videoFile)
1787 : VideoPathManager.Instance.getFSVideoFileOutputPath(this, videoFile)
1789 const promises: Promise<any>[] = [ remove(filePath) ]
1790 if (!isRedundancy) promises.push(videoFile.removeTorrent())
1792 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1793 promises.push(removeWebTorrentObjectStorage(videoFile))
1796 return Promise.all(promises)
1799 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1800 const directoryPath = isRedundancy
1801 ? getHLSRedundancyDirectory(this)
1802 : getHLSDirectory(this)
1804 await remove(directoryPath)
1806 if (isRedundancy !== true) {
1807 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1808 streamingPlaylistWithFiles.Video = this
1810 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1811 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1814 // Remove physical files and torrents
1816 streamingPlaylistWithFiles.VideoFiles.map(file => file.removeTorrent())
1819 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1820 await removeHLSObjectStorage(streamingPlaylist.withVideo(this))
1825 async removeStreamingPlaylistVideoFile (streamingPlaylist: MStreamingPlaylist, videoFile: MVideoFile) {
1826 const filePath = VideoPathManager.Instance.getFSHLSOutputPath(this, videoFile.filename)
1827 await videoFile.removeTorrent()
1828 await remove(filePath)
1830 const resolutionFilename = getHlsResolutionPlaylistFilename(videoFile.filename)
1831 await remove(VideoPathManager.Instance.getFSHLSOutputPath(this, resolutionFilename))
1833 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1834 await removeHLSFileObjectStorage(streamingPlaylist.withVideo(this), videoFile.filename)
1835 await removeHLSFileObjectStorage(streamingPlaylist.withVideo(this), resolutionFilename)
1839 async removeStreamingPlaylistFile (streamingPlaylist: MStreamingPlaylist, filename: string) {
1840 const filePath = VideoPathManager.Instance.getFSHLSOutputPath(this, filename)
1841 await remove(filePath)
1843 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1844 await removeHLSFileObjectStorage(streamingPlaylist.withVideo(this), filename)
1849 if (this.isOwned()) return false
1851 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1854 hasPrivacyForFederation () {
1855 return isPrivacyForFederation(this.privacy)
1858 hasStateForFederation () {
1859 return isStateForFederation(this.state)
1862 isNewVideo (newPrivacy: VideoPrivacy) {
1863 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
1866 setAsRefreshed (transaction?: Transaction) {
1867 return setAsUpdated('video', this.id, transaction)
1870 // ---------------------------------------------------------------------------
1872 requiresAuth (options: {
1874 checkBlacklist: boolean
1876 const { urlParamId, checkBlacklist } = options
1878 if (this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL) {
1882 if (this.privacy === VideoPrivacy.UNLISTED) {
1883 if (urlParamId && !isUUIDValid(urlParamId)) return true
1888 if (checkBlacklist && this.VideoBlacklist) return true
1890 if (this.privacy !== VideoPrivacy.PUBLIC) {
1891 throw new Error(`Unknown video privacy ${this.privacy} to know if the video requires auth`)
1897 hasPrivateStaticPath () {
1898 return isVideoInPrivateDirectory(this.privacy)
1901 // ---------------------------------------------------------------------------
1903 async setNewState (newState: VideoState, isNewVideo: boolean, transaction: Transaction) {
1904 if (this.state === newState) throw new Error('Cannot use same state ' + newState)
1906 this.state = newState
1908 if (this.state === VideoState.PUBLISHED && isNewVideo) {
1909 this.publishedAt = new Date()
1912 await this.save({ transaction })
1915 getBandwidthBits (this: MVideo, videoFile: MVideoFile) {
1916 if (!this.duration) throw new Error(`Cannot get bandwidth bits because video ${this.url} has duration of 0`)
1918 return Math.ceil((videoFile.size * 8) / this.duration)
1922 if (this.isOwned()) {
1924 WEBSERVER.URL + '/tracker/announce',
1925 WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket'
1929 return this.Trackers.map(t => t.url)