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 { removeHLSObjectStorage, removeWebTorrentObjectStorage } from '@server/lib/object-storage'
30 import { getHLSDirectory, getHLSRedundancyDirectory } from '@server/lib/paths'
31 import { VideoPathManager } from '@server/lib/video-path-manager'
32 import { getServerActor } from '@server/models/application/application'
33 import { ModelCache } from '@server/models/model-cache'
34 import { buildVideoEmbedPath, buildVideoWatchPath, pick } from '@shared/core-utils'
35 import { ffprobePromise, getAudioStream, uuidToShort } from '@shared/extra-utils'
49 VideoStreamingPlaylistType
50 } from '@shared/models'
51 import { AttributesOnly } from '@shared/typescript-utils'
52 import { peertubeTruncate } from '../../helpers/core-utils'
53 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
54 import { exists, isBooleanValid } from '../../helpers/custom-validators/misc'
56 isVideoDescriptionValid,
62 } from '../../helpers/custom-validators/videos'
63 import { getVideoStreamDimensionsInfo } from '../../helpers/ffmpeg'
64 import { logger } from '../../helpers/logger'
65 import { CONFIG } from '../../initializers/config'
66 import { ACTIVITY_PUB, API_VERSION, CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
67 import { sendDeleteVideo } from '../../lib/activitypub/send'
70 MChannelAccountDefault,
73 MStreamingPlaylistFilesVideo,
78 MVideoAccountLightBlacklistAllFiles,
83 MVideoFormattableDetails,
89 MVideoThumbnailBlacklist,
92 } from '../../types/models'
93 import { MThumbnail } from '../../types/models/video/thumbnail'
94 import { MVideoFile, MVideoFileStreamingPlaylistVideo } from '../../types/models/video/video-file'
95 import { VideoAbuseModel } from '../abuse/video-abuse'
96 import { AccountModel } from '../account/account'
97 import { AccountVideoRateModel } from '../account/account-video-rate'
98 import { ActorModel } from '../actor/actor'
99 import { ActorImageModel } from '../actor/actor-image'
100 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
101 import { ServerModel } from '../server/server'
102 import { TrackerModel } from '../server/tracker'
103 import { VideoTrackerModel } from '../server/video-tracker'
104 import { setAsUpdated } from '../shared'
105 import { UserModel } from '../user/user'
106 import { UserVideoHistoryModel } from '../user/user-video-history'
107 import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils'
108 import { VideoViewModel } from '../view/video-view'
110 videoFilesModelToFormattedJSON,
111 VideoFormattingJSONOptions,
112 videoModelToActivityPubObject,
113 videoModelToFormattedDetailsJSON,
114 videoModelToFormattedJSON
115 } from './formatter/video-format-utils'
116 import { ScheduleVideoUpdateModel } from './schedule-video-update'
118 BuildVideosListQueryOptions,
119 DisplayOnlyForFollowerOptions,
120 VideoModelGetQueryBuilder,
121 VideosIdListQueryBuilder,
122 VideosModelListQueryBuilder
124 import { TagModel } from './tag'
125 import { ThumbnailModel } from './thumbnail'
126 import { VideoBlacklistModel } from './video-blacklist'
127 import { VideoCaptionModel } from './video-caption'
128 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
129 import { VideoCommentModel } from './video-comment'
130 import { VideoFileModel } from './video-file'
131 import { VideoImportModel } from './video-import'
132 import { VideoJobInfoModel } from './video-job-info'
133 import { VideoLiveModel } from './video-live'
134 import { VideoPlaylistElementModel } from './video-playlist-element'
135 import { VideoShareModel } from './video-share'
136 import { VideoSourceModel } from './video-source'
137 import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
138 import { VideoTagModel } from './video-tag'
140 export enum ScopeNames {
142 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
143 WITH_TAGS = 'WITH_TAGS',
144 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
145 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
146 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
147 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
148 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
149 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
150 WITH_THUMBNAILS = 'WITH_THUMBNAILS'
153 export type ForAPIOptions = {
156 videoPlaylistId?: number
158 withAccountBlockerIds?: number[]
162 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
163 attributes: [ 'id', 'url', 'uuid', 'remote' ]
165 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
166 const include: Includeable[] = [
168 model: VideoChannelModel.scope({
170 VideoChannelScopeNames.SUMMARY, {
172 withAccountBlockerIds: options.withAccountBlockerIds
179 attributes: [ 'type', 'filename' ],
180 model: ThumbnailModel,
185 const query: FindOptions = {}
195 if (options.videoPlaylistId) {
197 model: VideoPlaylistElementModel.unscoped(),
200 videoPlaylistId: options.videoPlaylistId
205 query.include = include
209 [ScopeNames.WITH_THUMBNAILS]: {
212 model: ThumbnailModel,
217 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
220 model: VideoChannelModel.unscoped(),
225 exclude: [ 'privateKey', 'publicKey' ]
227 model: ActorModel.unscoped(),
231 attributes: [ 'host' ],
232 model: ServerModel.unscoped(),
236 model: ActorImageModel,
243 model: AccountModel.unscoped(),
247 model: ActorModel.unscoped(),
249 exclude: [ 'privateKey', 'publicKey' ]
254 attributes: [ 'host' ],
255 model: ServerModel.unscoped(),
259 model: ActorImageModel,
271 [ScopeNames.WITH_TAGS]: {
272 include: [ TagModel ]
274 [ScopeNames.WITH_BLACKLISTED]: {
277 attributes: [ 'id', 'reason', 'unfederated' ],
278 model: VideoBlacklistModel,
283 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
284 let subInclude: any[] = []
286 if (withRedundancies === true) {
289 attributes: [ 'fileUrl' ],
290 model: VideoRedundancyModel.unscoped(),
299 model: VideoFileModel,
307 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
308 const subInclude: IncludeOptions[] = [
310 model: VideoFileModel,
315 if (withRedundancies === true) {
317 attributes: [ 'fileUrl' ],
318 model: VideoRedundancyModel.unscoped(),
326 model: VideoStreamingPlaylistModel.unscoped(),
334 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
337 model: ScheduleVideoUpdateModel.unscoped(),
342 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
346 attributes: [ 'currentTime' ],
347 model: UserVideoHistoryModel.unscoped(),
360 buildTrigramSearchIndex('video_name_trigram', 'name'),
362 { fields: [ 'createdAt' ] },
365 { name: 'publishedAt', order: 'DESC' },
366 { name: 'id', order: 'ASC' }
369 { fields: [ 'duration' ] },
372 { name: 'views', order: 'DESC' },
373 { name: 'id', order: 'ASC' }
376 { fields: [ 'channelId' ] },
378 fields: [ 'originallyPublishedAt' ],
380 originallyPublishedAt: {
386 fields: [ 'category' ], // We don't care videos with an unknown category
394 fields: [ 'licence' ], // We don't care videos with an unknown licence
402 fields: [ 'language' ], // We don't care videos with an unknown language
410 fields: [ 'nsfw' ], // Most of the videos are not NSFW
416 fields: [ 'remote' ], // Only index local videos
431 export class VideoModel extends Model<Partial<AttributesOnly<VideoModel>>> {
434 @Default(DataType.UUIDV4)
436 @Column(DataType.UUID)
440 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
456 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
460 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
462 privacy: VideoPrivacy
465 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
471 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
472 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
477 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
478 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
482 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
517 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
518 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
523 commentsEnabled: boolean
527 downloadEnabled: boolean
531 waitTranscoding: boolean
535 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
546 @Default(DataType.NOW)
553 originallyPublishedAt: Date
555 @ForeignKey(() => VideoChannelModel)
559 @BelongsTo(() => VideoChannelModel, {
565 VideoChannel: VideoChannelModel
567 @BelongsToMany(() => TagModel, {
568 foreignKey: 'videoId',
569 through: () => VideoTagModel,
574 @BelongsToMany(() => TrackerModel, {
575 foreignKey: 'videoId',
576 through: () => VideoTrackerModel,
579 Trackers: TrackerModel[]
581 @HasMany(() => ThumbnailModel, {
589 Thumbnails: ThumbnailModel[]
591 @HasMany(() => VideoPlaylistElementModel, {
598 VideoPlaylistElements: VideoPlaylistElementModel[]
600 @HasOne(() => VideoSourceModel, {
607 VideoSource: VideoSourceModel
609 @HasMany(() => VideoAbuseModel, {
616 VideoAbuses: VideoAbuseModel[]
618 @HasMany(() => VideoFileModel, {
626 VideoFiles: VideoFileModel[]
628 @HasMany(() => VideoStreamingPlaylistModel, {
636 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
638 @HasMany(() => VideoShareModel, {
645 VideoShares: VideoShareModel[]
647 @HasMany(() => AccountVideoRateModel, {
654 AccountVideoRates: AccountVideoRateModel[]
656 @HasMany(() => VideoCommentModel, {
664 VideoComments: VideoCommentModel[]
666 @HasMany(() => VideoViewModel, {
673 VideoViews: VideoViewModel[]
675 @HasMany(() => UserVideoHistoryModel, {
682 UserVideoHistories: UserVideoHistoryModel[]
684 @HasOne(() => ScheduleVideoUpdateModel, {
691 ScheduleVideoUpdate: ScheduleVideoUpdateModel
693 @HasOne(() => VideoBlacklistModel, {
700 VideoBlacklist: VideoBlacklistModel
702 @HasOne(() => VideoLiveModel, {
709 VideoLive: VideoLiveModel
711 @HasOne(() => VideoImportModel, {
718 VideoImport: VideoImportModel
720 @HasMany(() => VideoCaptionModel, {
727 ['separate' as any]: true
729 VideoCaptions: VideoCaptionModel[]
731 @HasOne(() => VideoJobInfoModel, {
738 VideoJobInfo: VideoJobInfoModel
741 static async sendDelete (instance: MVideoAccountLight, options) {
742 if (!instance.isOwned()) return undefined
744 // Lazy load channels
745 if (!instance.VideoChannel) {
746 instance.VideoChannel = await instance.$get('VideoChannel', {
751 transaction: options.transaction
752 }) as MChannelAccountDefault
755 return sendDeleteVideo(instance, options.transaction)
759 static async removeFiles (instance: VideoModel, options) {
760 const tasks: Promise<any>[] = []
762 logger.info('Removing files of video %s.', instance.url)
764 if (instance.isOwned()) {
765 if (!Array.isArray(instance.VideoFiles)) {
766 instance.VideoFiles = await instance.$get('VideoFiles', { transaction: options.transaction })
769 // Remove physical files and torrents
770 instance.VideoFiles.forEach(file => {
771 tasks.push(instance.removeWebTorrentFileAndTorrent(file))
774 // Remove playlists file
775 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
776 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists', { transaction: options.transaction })
779 for (const p of instance.VideoStreamingPlaylists) {
780 tasks.push(instance.removeStreamingPlaylistFiles(p))
784 // Do not wait video deletion because we could be in a transaction
787 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 countLocalLives () {
1218 [Op.ne]: VideoState.LIVE_ENDED
1223 return VideoModel.count(options)
1226 static countVideosUploadedByUserSince (userId: number, since: Date) {
1230 model: VideoChannelModel.unscoped(),
1234 model: AccountModel.unscoped(),
1238 model: UserModel.unscoped(),
1256 return VideoModel.unscoped().count(options)
1259 static countLivesOfAccount (accountId: number) {
1265 [Op.ne]: VideoState.LIVE_ENDED
1271 model: VideoChannelModel.unscoped(),
1279 return VideoModel.count(options)
1282 static load (id: number | string, transaction?: Transaction): Promise<MVideoThumbnail> {
1283 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1285 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails' })
1288 static loadWithBlacklist (id: number | string, transaction?: Transaction): Promise<MVideoThumbnailBlacklist> {
1289 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1291 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails-blacklist' })
1294 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
1297 where: buildWhereIdOrUUID(id),
1301 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1304 return ModelCache.Instance.doCache({
1305 cacheType: 'load-video-immutable-id',
1312 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
1314 const query: FindOptions = {
1321 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1324 return ModelCache.Instance.doCache({
1325 cacheType: 'load-video-immutable-url',
1332 static loadOnlyId (id: number | string, transaction?: Transaction): Promise<MVideoId> {
1333 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1335 return queryBuilder.queryVideo({ id, transaction, type: 'id' })
1338 static loadWithFiles (id: number | string, transaction?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
1339 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1341 return queryBuilder.queryVideo({ id, transaction, type: 'all-files', logging })
1344 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
1345 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1347 return queryBuilder.queryVideo({ url, transaction, type: 'thumbnails' })
1350 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
1351 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1353 return queryBuilder.queryVideo({ url, transaction, type: 'account-blacklist-files' })
1356 static loadFull (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
1357 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1359 return queryBuilder.queryVideo({ id, transaction: t, type: 'full', userId })
1362 static loadForGetAPI (parameters: {
1364 transaction?: Transaction
1366 }): Promise<MVideoDetails> {
1367 const { id, transaction, userId } = parameters
1368 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1370 return queryBuilder.queryVideo({ id, transaction, type: 'api', userId })
1373 static async getStats () {
1374 const serverActor = await getServerActor()
1376 let totalLocalVideoViews = await VideoModel.sum('views', {
1382 // Sequelize could return null...
1383 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1385 const baseOptions = {
1388 sort: '-publishedAt',
1390 displayOnlyForFollower: {
1391 actorId: serverActor.id,
1396 const { total: totalLocalVideos } = await VideoModel.listForApi({
1402 const { total: totalVideos } = await VideoModel.listForApi(baseOptions)
1406 totalLocalVideoViews,
1411 static incrementViews (id: number, views: number) {
1412 return VideoModel.increment('views', {
1420 static updateRatesOf (videoId: number, type: VideoRateType, count: number, t: Transaction) {
1421 const field = type === 'like'
1425 const rawQuery = `UPDATE "video" SET "${field}" = :count WHERE "video"."id" = :videoId`
1427 return AccountVideoRateModel.sequelize.query(rawQuery, {
1429 replacements: { videoId, rateType: type, count },
1430 type: QueryTypes.UPDATE
1434 static syncLocalRates (videoId: number, type: VideoRateType, t: Transaction) {
1435 const field = type === 'like'
1439 const rawQuery = `UPDATE "video" SET "${field}" = ` +
1441 'SELECT COUNT(id) FROM "accountVideoRate" WHERE "accountVideoRate"."videoId" = "video"."id" AND type = :rateType' +
1443 'WHERE "video"."id" = :videoId'
1445 return AccountVideoRateModel.sequelize.query(rawQuery, {
1447 replacements: { videoId, rateType: type },
1448 type: QueryTypes.UPDATE
1452 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1453 // Instances only share videos
1454 const query = 'SELECT 1 FROM "videoShare" ' +
1455 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1456 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1460 type: QueryTypes.SELECT as QueryTypes.SELECT,
1461 bind: { followerActorId, videoId },
1465 return VideoModel.sequelize.query(query, options)
1466 .then(results => results.length === 1)
1469 static bulkUpdateSupportField (ofChannel: MChannel, t: Transaction) {
1472 channelId: ofChannel.id
1477 return VideoModel.update({ support: ofChannel.support }, options)
1480 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
1482 attributes: [ 'id' ],
1484 channelId: videoChannel.id
1488 return VideoModel.findAll(query)
1489 .then(videos => videos.map(v => v.id))
1492 // threshold corresponds to how many video the field should have to be returned
1493 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1494 const serverActor = await getServerActor()
1496 const queryOptions: BuildVideosListQueryOptions = {
1497 attributes: [ `"${field}"` ],
1498 group: `GROUP BY "${field}"`,
1499 having: `HAVING COUNT("${field}") >= ${threshold}`,
1503 serverAccountIdForBlock: serverActor.Account.id,
1504 displayOnlyForFollower: {
1505 actorId: serverActor.id,
1510 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1512 return queryBuilder.queryVideoIds(queryOptions)
1513 .then(rows => rows.map(r => r[field]))
1516 static buildTrendingQuery (trendingDays: number) {
1520 model: VideoViewModel,
1525 [Op.gte as any]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1531 private static async getAvailableForApi (
1532 options: BuildVideosListQueryOptions,
1534 ): Promise<ResultList<VideoModel>> {
1535 function getCount () {
1536 if (countVideos !== true) return Promise.resolve(undefined)
1538 const countOptions = Object.assign({}, options, { isCount: true })
1539 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1541 return queryBuilder.countVideoIds(countOptions)
1544 function getModels () {
1545 if (options.count === 0) return Promise.resolve([])
1547 const queryBuilder = new VideosModelListQueryBuilder(VideoModel.sequelize)
1549 return queryBuilder.queryVideos(options)
1552 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1560 private static throwIfPrivateIncludeWithoutUser (include: VideoInclude, user: MUserAccountId) {
1561 if (VideoModel.isPrivateInclude(include) && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1562 throw new Error('Try to filter all-local but user cannot see all videos')
1566 private static throwIfPrivacyOneOfWithoutUser (privacyOneOf: VideoPrivacy[], user: MUserAccountId) {
1567 if (privacyOneOf && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1568 throw new Error('Try to choose video privacies but user cannot see all videos')
1572 private static isPrivateInclude (include: VideoInclude) {
1573 return include & VideoInclude.BLACKLISTED ||
1574 include & VideoInclude.BLOCKED_OWNER ||
1575 include & VideoInclude.NOT_PUBLISHED_STATE
1579 return !!this.VideoBlacklist
1583 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1586 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1587 // We first transcode to WebTorrent format, so try this array first
1588 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
1589 const file = fun(this.VideoFiles, file => file.resolution)
1591 return Object.assign(file, { Video: this })
1594 // No webtorrent files, try with streaming playlist files
1595 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1596 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1598 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
1599 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1605 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1606 return this.getQualityFileBy(maxBy)
1609 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1610 return this.getQualityFileBy(minBy)
1613 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1614 if (Array.isArray(this.VideoFiles) === false) return undefined
1616 const file = this.VideoFiles.find(f => f.resolution === resolution)
1617 if (!file) return undefined
1619 return Object.assign(file, { Video: this })
1622 hasWebTorrentFiles () {
1623 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1626 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction?: Transaction) {
1627 thumbnail.videoId = this.id
1629 const savedThumbnail = await thumbnail.save({ transaction })
1631 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1633 this.Thumbnails = this.Thumbnails.filter(t => t.id !== savedThumbnail.id)
1634 this.Thumbnails.push(savedThumbnail)
1638 if (Array.isArray(this.Thumbnails) === false) return undefined
1640 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1644 return !!this.getPreview()
1648 if (Array.isArray(this.Thumbnails) === false) return undefined
1650 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1654 return this.remote === false
1657 getWatchStaticPath () {
1658 return buildVideoWatchPath({ shortUUID: uuidToShort(this.uuid) })
1661 getEmbedStaticPath () {
1662 return buildVideoEmbedPath(this)
1665 getMiniatureStaticPath () {
1666 const thumbnail = this.getMiniature()
1667 if (!thumbnail) return null
1669 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1672 getPreviewStaticPath () {
1673 const preview = this.getPreview()
1674 if (!preview) return null
1676 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1677 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1680 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1681 return videoModelToFormattedJSON(this, options)
1684 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1685 return videoModelToFormattedDetailsJSON(this)
1688 getFormattedVideoFilesJSON (includeMagnet = true): VideoFile[] {
1689 let files: VideoFile[] = []
1691 if (Array.isArray(this.VideoFiles)) {
1692 const result = videoFilesModelToFormattedJSON(this, this.VideoFiles, includeMagnet)
1693 files = files.concat(result)
1696 for (const p of (this.VideoStreamingPlaylists || [])) {
1697 const result = videoFilesModelToFormattedJSON(this, p.VideoFiles, includeMagnet)
1698 files = files.concat(result)
1704 toActivityPubObject (this: MVideoAP): VideoObject {
1705 return videoModelToActivityPubObject(this)
1708 getTruncatedDescription () {
1709 if (!this.description) return null
1711 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1712 return peertubeTruncate(this.description, { length: maxLength })
1716 let files: MVideoFile[] = []
1718 if (Array.isArray(this.VideoFiles)) {
1719 files = files.concat(this.VideoFiles)
1722 if (Array.isArray(this.VideoStreamingPlaylists)) {
1723 for (const p of this.VideoStreamingPlaylists) {
1724 if (Array.isArray(p.VideoFiles)) {
1725 files = files.concat(p.VideoFiles)
1733 probeMaxQualityFile () {
1734 const file = this.getMaxQualityFile()
1735 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1737 return VideoPathManager.Instance.makeAvailableVideoFile(file.withVideoOrPlaylist(videoOrPlaylist), async originalFilePath => {
1738 const probe = await ffprobePromise(originalFilePath)
1740 const { audioStream } = await getAudioStream(originalFilePath, probe)
1745 ...await getVideoStreamDimensionsInfo(originalFilePath, probe)
1750 getDescriptionAPIPath () {
1751 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1754 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1755 if (!this.VideoStreamingPlaylists) return undefined
1757 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1758 if (!playlist) return undefined
1760 playlist.Video = this
1765 setHLSPlaylist (playlist: MStreamingPlaylist) {
1766 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1768 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1769 this.VideoStreamingPlaylists = toAdd
1773 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1774 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1778 removeWebTorrentFileAndTorrent (videoFile: MVideoFile, isRedundancy = false) {
1779 const filePath = isRedundancy
1780 ? VideoPathManager.Instance.getFSRedundancyVideoFilePath(this, videoFile)
1781 : VideoPathManager.Instance.getFSVideoFileOutputPath(this, videoFile)
1783 const promises: Promise<any>[] = [ remove(filePath) ]
1784 if (!isRedundancy) promises.push(videoFile.removeTorrent())
1786 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1787 promises.push(removeWebTorrentObjectStorage(videoFile))
1790 return Promise.all(promises)
1793 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1794 const directoryPath = isRedundancy
1795 ? getHLSRedundancyDirectory(this)
1796 : getHLSDirectory(this)
1798 await remove(directoryPath)
1800 if (isRedundancy !== true) {
1801 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1802 streamingPlaylistWithFiles.Video = this
1804 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1805 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1808 // Remove physical files and torrents
1810 streamingPlaylistWithFiles.VideoFiles.map(file => file.removeTorrent())
1813 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1814 await removeHLSObjectStorage(streamingPlaylist.withVideo(this))
1820 if (this.isOwned()) return false
1822 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1825 hasPrivacyForFederation () {
1826 return isPrivacyForFederation(this.privacy)
1829 hasStateForFederation () {
1830 return isStateForFederation(this.state)
1833 isNewVideo (newPrivacy: VideoPrivacy) {
1834 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
1837 setAsRefreshed (transaction?: Transaction) {
1838 return setAsUpdated('video', this.id, transaction)
1842 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
1845 setPrivacy (newPrivacy: VideoPrivacy) {
1846 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
1847 this.publishedAt = new Date()
1850 this.privacy = newPrivacy
1854 return this.privacy === VideoPrivacy.PRIVATE ||
1855 this.privacy === VideoPrivacy.UNLISTED ||
1856 this.privacy === VideoPrivacy.INTERNAL
1859 async setNewState (newState: VideoState, isNewVideo: boolean, transaction: Transaction) {
1860 if (this.state === newState) throw new Error('Cannot use same state ' + newState)
1862 this.state = newState
1864 if (this.state === VideoState.PUBLISHED && isNewVideo) {
1865 this.publishedAt = new Date()
1868 await this.save({ transaction })
1871 getBandwidthBits (this: MVideo, videoFile: MVideoFile) {
1872 return Math.ceil((videoFile.size * 8) / this.duration)
1876 if (this.isOwned()) {
1878 WEBSERVER.URL + '/tracker/announce',
1879 WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket'
1883 return this.Trackers.map(t => t.url)