1 import * as Bluebird from 'bluebird'
2 import { remove } from 'fs-extra'
3 import { maxBy, minBy, pick } 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 { buildNSFWFilter } from '@server/helpers/express-utils'
28 import { getPrivaciesForFederation, isPrivacyForFederation, isStateForFederation } from '@server/helpers/video'
29 import { LiveManager } from '@server/lib/live-manager'
30 import { getHLSDirectory, getTorrentFileName, getTorrentFilePath, getVideoFilename, getVideoFilePath } from '@server/lib/video-paths'
31 import { getServerActor } from '@server/models/application/application'
32 import { ModelCache } from '@server/models/model-cache'
33 import { VideoFile } from '@shared/models/videos/video-file.model'
34 import { ResultList, UserRight, VideoPrivacy, VideoState } from '../../../shared'
35 import { VideoObject } from '../../../shared/models/activitypub/objects'
36 import { Video, VideoDetails } from '../../../shared/models/videos'
37 import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
38 import { VideoFilter } from '../../../shared/models/videos/video-query.type'
39 import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
40 import { peertubeTruncate } from '../../helpers/core-utils'
41 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
42 import { isBooleanValid } from '../../helpers/custom-validators/misc'
45 isVideoDescriptionValid,
53 } from '../../helpers/custom-validators/videos'
54 import { getVideoFileResolution } from '../../helpers/ffprobe-utils'
55 import { logger } from '../../helpers/logger'
56 import { CONFIG } from '../../initializers/config'
63 STATIC_DOWNLOAD_PATHS,
71 } from '../../initializers/constants'
72 import { sendDeleteVideo } from '../../lib/activitypub/send'
75 MChannelAccountDefault,
78 MStreamingPlaylistFilesVideo,
82 MVideoAccountLightBlacklistAllFiles,
87 MVideoFormattableDetails,
93 MVideoThumbnailBlacklist,
97 } from '../../types/models'
98 import { MThumbnail } from '../../types/models/video/thumbnail'
99 import { MVideoFile, MVideoFileRedundanciesOpt, MVideoFileStreamingPlaylistVideo } from '../../types/models/video/video-file'
100 import { VideoAbuseModel } from '../abuse/video-abuse'
101 import { AccountModel } from '../account/account'
102 import { AccountVideoRateModel } from '../account/account-video-rate'
103 import { UserVideoHistoryModel } from '../account/user-video-history'
104 import { ActorModel } from '../activitypub/actor'
105 import { AvatarModel } from '../avatar/avatar'
106 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
107 import { ServerModel } from '../server/server'
108 import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils'
109 import { ScheduleVideoUpdateModel } from './schedule-video-update'
110 import { TagModel } from './tag'
111 import { ThumbnailModel } from './thumbnail'
112 import { VideoBlacklistModel } from './video-blacklist'
113 import { VideoCaptionModel } from './video-caption'
114 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
115 import { VideoCommentModel } from './video-comment'
116 import { VideoFileModel } from './video-file'
118 videoFilesModelToFormattedJSON,
119 VideoFormattingJSONOptions,
120 videoModelToActivityPubObject,
121 videoModelToFormattedDetailsJSON,
122 videoModelToFormattedJSON
123 } from './video-format-utils'
124 import { VideoImportModel } from './video-import'
125 import { VideoLiveModel } from './video-live'
126 import { VideoPlaylistElementModel } from './video-playlist-element'
127 import { buildListQuery, BuildVideosQueryOptions, wrapForAPIResults } from './video-query-builder'
128 import { VideoShareModel } from './video-share'
129 import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
130 import { VideoTagModel } from './video-tag'
131 import { VideoViewModel } from './video-view'
132 import { UserModel } from '../account/user'
134 export enum ScopeNames {
135 AVAILABLE_FOR_LIST_IDS = 'AVAILABLE_FOR_LIST_IDS',
137 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
138 WITH_TAGS = 'WITH_TAGS',
139 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
140 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
141 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
142 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
143 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
144 WITH_USER_ID = 'WITH_USER_ID',
145 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
146 WITH_THUMBNAILS = 'WITH_THUMBNAILS',
147 WITH_LIVE = 'WITH_LIVE'
150 export type ForAPIOptions = {
153 videoPlaylistId?: number
155 withAccountBlockerIds?: number[]
158 export type AvailableForListIDsOptions = {
159 serverAccountId: number
160 followerActorId: number
161 includeLocalVideos: boolean
163 attributesType?: 'none' | 'id' | 'all'
166 categoryOneOf?: number[]
168 licenceOneOf?: number[]
169 languageOneOf?: string[]
176 videoChannelId?: number
178 videoPlaylistId?: number
180 trendingDays?: number
181 user?: MUserAccountId
182 historyOfUser?: MUserId
184 baseWhere?: WhereOptions[]
188 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
189 attributes: [ 'id', 'url', 'uuid', 'remote' ]
191 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
192 const include: Includeable[] = [
194 model: VideoChannelModel.scope({
196 VideoChannelScopeNames.SUMMARY, {
198 withAccountBlockerIds: options.withAccountBlockerIds
205 attributes: [ 'type', 'filename' ],
206 model: ThumbnailModel,
211 const query: FindOptions = {}
221 if (options.videoPlaylistId) {
223 model: VideoPlaylistElementModel.unscoped(),
226 videoPlaylistId: options.videoPlaylistId
231 query.include = include
235 [ScopeNames.WITH_THUMBNAILS]: {
238 model: ThumbnailModel,
243 [ScopeNames.WITH_LIVE]: {
246 model: VideoLiveModel.unscoped(),
251 [ScopeNames.WITH_USER_ID]: {
254 attributes: [ 'accountId' ],
255 model: VideoChannelModel.unscoped(),
259 attributes: [ 'userId' ],
260 model: AccountModel.unscoped(),
267 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
270 model: VideoChannelModel.unscoped(),
275 exclude: [ 'privateKey', 'publicKey' ]
277 model: ActorModel.unscoped(),
281 attributes: [ 'host' ],
282 model: ServerModel.unscoped(),
286 model: AvatarModel.unscoped(),
292 model: AccountModel.unscoped(),
296 model: ActorModel.unscoped(),
298 exclude: [ 'privateKey', 'publicKey' ]
303 attributes: [ 'host' ],
304 model: ServerModel.unscoped(),
308 model: AvatarModel.unscoped(),
319 [ScopeNames.WITH_TAGS]: {
320 include: [ TagModel ]
322 [ScopeNames.WITH_BLACKLISTED]: {
325 attributes: [ 'id', 'reason', 'unfederated' ],
326 model: VideoBlacklistModel,
331 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
332 let subInclude: any[] = []
334 if (withRedundancies === true) {
337 attributes: [ 'fileUrl' ],
338 model: VideoRedundancyModel.unscoped(),
347 model: VideoFileModel,
348 separate: true, // We may have multiple files, having multiple redundancies so let's separate this join
355 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
356 const subInclude: IncludeOptions[] = [
358 model: VideoFileModel,
363 if (withRedundancies === true) {
365 attributes: [ 'fileUrl' ],
366 model: VideoRedundancyModel.unscoped(),
374 model: VideoStreamingPlaylistModel.unscoped(),
375 separate: true, // We may have multiple streaming playlists, having multiple redundancies so let's separate this join
382 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
385 model: ScheduleVideoUpdateModel.unscoped(),
390 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
394 attributes: [ 'currentTime' ],
395 model: UserVideoHistoryModel.unscoped(),
408 buildTrigramSearchIndex('video_name_trigram', 'name'),
410 { fields: [ 'createdAt' ] },
413 { name: 'publishedAt', order: 'DESC' },
414 { name: 'id', order: 'ASC' }
417 { fields: [ 'duration' ] },
418 { fields: [ 'views' ] },
419 { fields: [ 'channelId' ] },
421 fields: [ 'originallyPublishedAt' ],
423 originallyPublishedAt: {
429 fields: [ 'category' ], // We don't care videos with an unknown category
437 fields: [ 'licence' ], // We don't care videos with an unknown licence
445 fields: [ 'language' ], // We don't care videos with an unknown language
453 fields: [ 'nsfw' ], // Most of the videos are not NSFW
459 fields: [ 'remote' ], // Only index local videos
474 export class VideoModel extends Model {
477 @Default(DataType.UUIDV4)
479 @Column(DataType.UUID)
483 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
489 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category', true))
495 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence', true))
501 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language', true))
502 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
506 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
508 privacy: VideoPrivacy
511 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
517 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
518 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
523 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
524 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
528 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
563 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
564 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
569 commentsEnabled: boolean
573 downloadEnabled: boolean
577 waitTranscoding: boolean
581 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
592 @Default(DataType.NOW)
599 originallyPublishedAt: Date
601 @ForeignKey(() => VideoChannelModel)
605 @BelongsTo(() => VideoChannelModel, {
611 VideoChannel: VideoChannelModel
613 @BelongsToMany(() => TagModel, {
614 foreignKey: 'videoId',
615 through: () => VideoTagModel,
620 @HasMany(() => ThumbnailModel, {
628 Thumbnails: ThumbnailModel[]
630 @HasMany(() => VideoPlaylistElementModel, {
637 VideoPlaylistElements: VideoPlaylistElementModel[]
639 @HasMany(() => VideoAbuseModel, {
646 VideoAbuses: VideoAbuseModel[]
648 @HasMany(() => VideoFileModel, {
656 VideoFiles: VideoFileModel[]
658 @HasMany(() => VideoStreamingPlaylistModel, {
666 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
668 @HasMany(() => VideoShareModel, {
675 VideoShares: VideoShareModel[]
677 @HasMany(() => AccountVideoRateModel, {
684 AccountVideoRates: AccountVideoRateModel[]
686 @HasMany(() => VideoCommentModel, {
694 VideoComments: VideoCommentModel[]
696 @HasMany(() => VideoViewModel, {
703 VideoViews: VideoViewModel[]
705 @HasMany(() => UserVideoHistoryModel, {
712 UserVideoHistories: UserVideoHistoryModel[]
714 @HasOne(() => ScheduleVideoUpdateModel, {
721 ScheduleVideoUpdate: ScheduleVideoUpdateModel
723 @HasOne(() => VideoBlacklistModel, {
730 VideoBlacklist: VideoBlacklistModel
732 @HasOne(() => VideoLiveModel, {
739 VideoLive: VideoLiveModel
741 @HasOne(() => VideoImportModel, {
748 VideoImport: VideoImportModel
750 @HasMany(() => VideoCaptionModel, {
757 ['separate' as any]: true
759 VideoCaptions: VideoCaptionModel[]
762 static async sendDelete (instance: MVideoAccountLight, options) {
763 if (instance.isOwned()) {
764 if (!instance.VideoChannel) {
765 instance.VideoChannel = await instance.$get('VideoChannel', {
770 transaction: options.transaction
771 }) as MChannelAccountDefault
774 return sendDeleteVideo(instance, options.transaction)
781 static async removeFiles (instance: VideoModel) {
782 const tasks: Promise<any>[] = []
784 logger.info('Removing files of video %s.', instance.url)
786 if (instance.isOwned()) {
787 if (!Array.isArray(instance.VideoFiles)) {
788 instance.VideoFiles = await instance.$get('VideoFiles')
791 // Remove physical files and torrents
792 instance.VideoFiles.forEach(file => {
793 tasks.push(instance.removeFile(file))
794 tasks.push(instance.removeTorrent(file))
797 // Remove playlists file
798 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
799 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists')
802 for (const p of instance.VideoStreamingPlaylists) {
803 tasks.push(instance.removeStreamingPlaylistFiles(p))
807 // Do not wait video deletion because we could be in a transaction
810 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
817 static stopLiveIfNeeded (instance: VideoModel) {
818 if (!instance.isLive) return
820 logger.info('Stopping live of video %s after video deletion.', instance.uuid)
822 return LiveManager.Instance.stopSessionOf(instance.id)
826 static invalidateCache (instance: VideoModel) {
827 ModelCache.Instance.invalidateCache('video', instance.id)
831 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
832 const tasks: Promise<any>[] = []
834 if (!Array.isArray(instance.VideoAbuses)) {
835 instance.VideoAbuses = await instance.$get('VideoAbuses')
837 if (instance.VideoAbuses.length === 0) return undefined
840 logger.info('Saving video abuses details of video %s.', instance.url)
842 const details = instance.toFormattedDetailsJSON()
844 for (const abuse of instance.VideoAbuses) {
845 abuse.deletedVideo = details
846 tasks.push(abuse.save({ transaction: options.transaction }))
851 logger.error('Some errors when saving details of video %s in its abuses before destroy hook.', instance.uuid, { err })
857 static listLocal (): Promise<MVideoWithAllFiles[]> {
864 return VideoModel.scope([
865 ScopeNames.WITH_WEBTORRENT_FILES,
866 ScopeNames.WITH_STREAMING_PLAYLISTS,
867 ScopeNames.WITH_THUMBNAILS
871 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
872 function getRawQuery (select: string) {
873 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
874 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
875 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
876 'WHERE "Account"."actorId" = ' + actorId
877 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
878 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
879 'WHERE "VideoShare"."actorId" = ' + actorId
881 return `(${queryVideo}) UNION (${queryVideoShare})`
884 const rawQuery = getRawQuery('"Video"."id"')
885 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
891 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ] as any), // FIXME: sequelize typings
894 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
896 [Op.or]: getPrivaciesForFederation()
900 attributes: [ 'language', 'fileUrl' ],
901 model: VideoCaptionModel.unscoped(),
905 attributes: [ 'id', 'url' ],
906 model: VideoShareModel.unscoped(),
908 // We only want videos shared by this actor
923 attributes: [ 'id', 'url' ],
924 model: ActorModel.unscoped()
929 model: VideoChannelModel.unscoped(),
933 attributes: [ 'name' ],
934 model: AccountModel.unscoped(),
938 attributes: [ 'id', 'url', 'followersUrl' ],
939 model: ActorModel.unscoped(),
945 attributes: [ 'id', 'url', 'followersUrl' ],
946 model: ActorModel.unscoped(),
952 model: VideoStreamingPlaylistModel.unscoped(),
956 model: VideoFileModel,
961 VideoLiveModel.unscoped(),
967 return Bluebird.all([
968 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
969 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
970 ]).then(([ rows, totals ]) => {
971 // totals: totalVideos + totalVideoShares
973 let totalVideoShares = 0
974 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
975 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
977 const total = totalVideos + totalVideoShares
985 static async listPublishedLiveIds () {
987 attributes: [ 'id' ],
990 state: VideoState.PUBLISHED
994 const result = await VideoModel.findAll(options)
996 return result.map(v => v.id)
999 static listUserVideosForApi (options: {
1006 const { accountId, start, count, sort, search } = options
1008 function buildBaseQuery (): FindOptions {
1012 order: getVideoSort(sort),
1015 model: VideoChannelModel,
1019 model: AccountModel,
1031 baseQuery = Object.assign(baseQuery, {
1034 [Op.iLike]: '%' + search + '%'
1043 const countQuery = buildBaseQuery()
1044 const findQuery = buildBaseQuery()
1046 const findScopes: (string | ScopeOptions)[] = [
1047 ScopeNames.WITH_SCHEDULED_UPDATE,
1048 ScopeNames.WITH_BLACKLISTED,
1049 ScopeNames.WITH_THUMBNAILS
1052 return Promise.all([
1053 VideoModel.count(countQuery),
1054 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
1055 ]).then(([ count, rows ]) => {
1063 static async listForApi (options: {
1068 includeLocalVideos: boolean
1070 categoryOneOf?: number[]
1071 licenceOneOf?: number[]
1072 languageOneOf?: string[]
1073 tagsOneOf?: string[]
1074 tagsAllOf?: string[]
1075 filter?: VideoFilter
1077 videoChannelId?: number
1078 followerActorId?: number
1079 videoPlaylistId?: number
1080 trendingDays?: number
1081 user?: MUserAccountId
1082 historyOfUser?: MUserId
1083 countVideos?: boolean
1086 if ((options.filter === 'all-local' || options.filter === 'all') && !options.user.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1087 throw new Error('Try to filter all-local but no user has not the see all videos right')
1090 const trendingDays = options.sort.endsWith('trending')
1091 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1094 const serverActor = await getServerActor()
1096 // followerActorId === null has a meaning, so just check undefined
1097 const followerActorId = options.followerActorId !== undefined
1098 ? options.followerActorId
1101 const queryOptions = {
1102 start: options.start,
1103 count: options.count,
1106 serverAccountId: serverActor.Account.id,
1108 categoryOneOf: options.categoryOneOf,
1109 licenceOneOf: options.licenceOneOf,
1110 languageOneOf: options.languageOneOf,
1111 tagsOneOf: options.tagsOneOf,
1112 tagsAllOf: options.tagsAllOf,
1113 filter: options.filter,
1114 withFiles: options.withFiles,
1115 accountId: options.accountId,
1116 videoChannelId: options.videoChannelId,
1117 videoPlaylistId: options.videoPlaylistId,
1118 includeLocalVideos: options.includeLocalVideos,
1120 historyOfUser: options.historyOfUser,
1122 search: options.search
1125 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
1128 static async searchAndPopulateAccountAndServer (options: {
1129 includeLocalVideos: boolean
1134 startDate?: string // ISO 8601
1135 endDate?: string // ISO 8601
1136 originallyPublishedStartDate?: string
1137 originallyPublishedEndDate?: string
1139 categoryOneOf?: number[]
1140 licenceOneOf?: number[]
1141 languageOneOf?: string[]
1142 tagsOneOf?: string[]
1143 tagsAllOf?: string[]
1144 durationMin?: number // seconds
1145 durationMax?: number // seconds
1146 user?: MUserAccountId
1147 filter?: VideoFilter
1149 const serverActor = await getServerActor()
1150 const queryOptions = {
1151 followerActorId: serverActor.id,
1152 serverAccountId: serverActor.Account.id,
1153 includeLocalVideos: options.includeLocalVideos,
1155 categoryOneOf: options.categoryOneOf,
1156 licenceOneOf: options.licenceOneOf,
1157 languageOneOf: options.languageOneOf,
1158 tagsOneOf: options.tagsOneOf,
1159 tagsAllOf: options.tagsAllOf,
1161 filter: options.filter,
1162 start: options.start,
1163 count: options.count,
1165 startDate: options.startDate,
1166 endDate: options.endDate,
1167 originallyPublishedStartDate: options.originallyPublishedStartDate,
1168 originallyPublishedEndDate: options.originallyPublishedEndDate,
1170 durationMin: options.durationMin,
1171 durationMax: options.durationMax,
1173 search: options.search
1176 return VideoModel.getAvailableForApi(queryOptions)
1179 static countLocalLives () {
1185 [Op.ne]: VideoState.LIVE_ENDED
1190 return VideoModel.count(options)
1193 static countVideosUploadedByUserSince (userId: number, since: Date) {
1197 model: VideoChannelModel.unscoped(),
1201 model: AccountModel.unscoped(),
1205 model: UserModel.unscoped(),
1223 return VideoModel.unscoped().count(options)
1226 static countLivesOfAccount (accountId: number) {
1232 [Op.ne]: VideoState.LIVE_ENDED
1238 model: VideoChannelModel.unscoped(),
1246 return VideoModel.count(options)
1249 static load (id: number | string, t?: Transaction): Promise<MVideoThumbnail> {
1250 const where = buildWhereIdOrUUID(id)
1256 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1259 static loadWithBlacklist (id: number | string, t?: Transaction): Promise<MVideoThumbnailBlacklist> {
1260 const where = buildWhereIdOrUUID(id)
1266 return VideoModel.scope([
1267 ScopeNames.WITH_THUMBNAILS,
1268 ScopeNames.WITH_BLACKLISTED
1272 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
1275 where: buildWhereIdOrUUID(id),
1279 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1282 return ModelCache.Instance.doCache({
1283 cacheType: 'load-video-immutable-id',
1290 static loadWithRights (id: number | string, t?: Transaction): Promise<MVideoWithRights> {
1291 const where = buildWhereIdOrUUID(id)
1297 return VideoModel.scope([
1298 ScopeNames.WITH_BLACKLISTED,
1299 ScopeNames.WITH_USER_ID,
1300 ScopeNames.WITH_THUMBNAILS
1304 static loadOnlyId (id: number | string, t?: Transaction): Promise<MVideoIdThumbnail> {
1305 const where = buildWhereIdOrUUID(id)
1308 attributes: [ 'id' ],
1313 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1316 static loadWithFiles (id: number | string, t?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
1317 const where = buildWhereIdOrUUID(id)
1325 return VideoModel.scope([
1326 ScopeNames.WITH_WEBTORRENT_FILES,
1327 ScopeNames.WITH_STREAMING_PLAYLISTS,
1328 ScopeNames.WITH_THUMBNAILS
1332 static loadByUUID (uuid: string): Promise<MVideoThumbnail> {
1339 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1342 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
1343 const query: FindOptions = {
1350 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(query)
1353 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
1355 const query: FindOptions = {
1362 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1365 return ModelCache.Instance.doCache({
1366 cacheType: 'load-video-immutable-url',
1373 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
1374 const query: FindOptions = {
1381 return VideoModel.scope([
1382 ScopeNames.WITH_ACCOUNT_DETAILS,
1383 ScopeNames.WITH_WEBTORRENT_FILES,
1384 ScopeNames.WITH_STREAMING_PLAYLISTS,
1385 ScopeNames.WITH_THUMBNAILS,
1386 ScopeNames.WITH_BLACKLISTED
1390 static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
1391 const where = buildWhereIdOrUUID(id)
1394 order: [ [ 'Tags', 'name', 'ASC' ] ] as any,
1399 const scopes: (string | ScopeOptions)[] = [
1400 ScopeNames.WITH_TAGS,
1401 ScopeNames.WITH_BLACKLISTED,
1402 ScopeNames.WITH_ACCOUNT_DETAILS,
1403 ScopeNames.WITH_SCHEDULED_UPDATE,
1404 ScopeNames.WITH_WEBTORRENT_FILES,
1405 ScopeNames.WITH_STREAMING_PLAYLISTS,
1406 ScopeNames.WITH_THUMBNAILS,
1407 ScopeNames.WITH_LIVE
1411 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1419 static loadForGetAPI (parameters: {
1423 }): Promise<MVideoDetails> {
1424 const { id, t, userId } = parameters
1425 const where = buildWhereIdOrUUID(id)
1428 order: [ [ 'Tags', 'name', 'ASC' ] ] as any, // FIXME: sequelize typings
1433 const scopes: (string | ScopeOptions)[] = [
1434 ScopeNames.WITH_TAGS,
1435 ScopeNames.WITH_BLACKLISTED,
1436 ScopeNames.WITH_ACCOUNT_DETAILS,
1437 ScopeNames.WITH_SCHEDULED_UPDATE,
1438 ScopeNames.WITH_THUMBNAILS,
1439 ScopeNames.WITH_LIVE,
1440 { method: [ ScopeNames.WITH_WEBTORRENT_FILES, true ] },
1441 { method: [ ScopeNames.WITH_STREAMING_PLAYLISTS, true ] }
1445 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1453 static async getStats () {
1454 const totalLocalVideos = await VideoModel.count({
1460 let totalLocalVideoViews = await VideoModel.sum('views', {
1466 // Sequelize could return null...
1467 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1469 const { total: totalVideos } = await VideoModel.listForApi({
1472 sort: '-publishedAt',
1473 nsfw: buildNSFWFilter(),
1474 includeLocalVideos: true,
1480 totalLocalVideoViews,
1485 static incrementViews (id: number, views: number) {
1486 return VideoModel.increment('views', {
1494 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1495 // Instances only share videos
1496 const query = 'SELECT 1 FROM "videoShare" ' +
1497 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1498 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1502 type: QueryTypes.SELECT as QueryTypes.SELECT,
1503 bind: { followerActorId, videoId },
1507 return VideoModel.sequelize.query(query, options)
1508 .then(results => results.length === 1)
1511 static bulkUpdateSupportField (videoChannel: MChannel, t: Transaction) {
1514 channelId: videoChannel.id
1519 return VideoModel.update({ support: videoChannel.support }, options)
1522 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
1524 attributes: [ 'id' ],
1526 channelId: videoChannel.id
1530 return VideoModel.findAll(query)
1531 .then(videos => videos.map(v => v.id))
1534 // threshold corresponds to how many video the field should have to be returned
1535 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1536 const serverActor = await getServerActor()
1537 const followerActorId = serverActor.id
1539 const queryOptions: BuildVideosQueryOptions = {
1540 attributes: [ `"${field}"` ],
1541 group: `GROUP BY "${field}"`,
1542 having: `HAVING COUNT("${field}") >= ${threshold}`,
1546 serverAccountId: serverActor.Account.id,
1548 includeLocalVideos: true
1551 const { query, replacements } = buildListQuery(VideoModel, queryOptions)
1553 return this.sequelize.query<any>(query, { replacements, type: QueryTypes.SELECT })
1554 .then(rows => rows.map(r => r[field]))
1557 static buildTrendingQuery (trendingDays: number) {
1561 model: VideoViewModel,
1565 [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1571 private static async getAvailableForApi (
1572 options: BuildVideosQueryOptions,
1574 ): Promise<ResultList<VideoModel>> {
1575 function getCount () {
1576 if (countVideos !== true) return Promise.resolve(undefined)
1578 const countOptions = Object.assign({}, options, { isCount: true })
1579 const { query: queryCount, replacements: replacementsCount } = buildListQuery(VideoModel, countOptions)
1581 return VideoModel.sequelize.query<any>(queryCount, { replacements: replacementsCount, type: QueryTypes.SELECT })
1582 .then(rows => rows.length !== 0 ? rows[0].total : 0)
1585 function getModels () {
1586 if (options.count === 0) return Promise.resolve([])
1588 const { query, replacements, order } = buildListQuery(VideoModel, options)
1589 const queryModels = wrapForAPIResults(query, replacements, options, order)
1591 return VideoModel.sequelize.query<any>(queryModels, { replacements, type: QueryTypes.SELECT, nest: true })
1592 .then(rows => VideoModel.buildAPIResult(rows))
1595 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1603 private static buildAPIResult (rows: any[]) {
1604 const videosMemo: { [ id: number ]: VideoModel } = {}
1605 const videoStreamingPlaylistMemo: { [ id: number ]: VideoStreamingPlaylistModel } = {}
1607 const thumbnailsDone = new Set<number>()
1608 const historyDone = new Set<number>()
1609 const videoFilesDone = new Set<number>()
1611 const videos: VideoModel[] = []
1613 const avatarKeys = [ 'id', 'filename', 'fileUrl', 'onDisk', 'createdAt', 'updatedAt' ]
1614 const actorKeys = [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ]
1615 const serverKeys = [ 'id', 'host' ]
1616 const videoFileKeys = [
1626 'videoStreamingPlaylistId'
1628 const videoStreamingPlaylistKeys = [ 'id', 'type', 'playlistUrl' ]
1652 'originallyPublishedAt',
1658 function buildActor (rowActor: any) {
1659 const avatarModel = rowActor.Avatar.id !== null
1660 ? new AvatarModel(pick(rowActor.Avatar, avatarKeys))
1663 const serverModel = rowActor.Server.id !== null
1664 ? new ServerModel(pick(rowActor.Server, serverKeys))
1667 const actorModel = new ActorModel(pick(rowActor, actorKeys))
1668 actorModel.Avatar = avatarModel
1669 actorModel.Server = serverModel
1674 for (const row of rows) {
1675 if (!videosMemo[row.id]) {
1677 const channel = row.VideoChannel
1678 const channelModel = new VideoChannelModel(pick(channel, [ 'id', 'name', 'description', 'actorId' ]))
1679 channelModel.Actor = buildActor(channel.Actor)
1681 const account = row.VideoChannel.Account
1682 const accountModel = new AccountModel(pick(account, [ 'id', 'name' ]))
1683 accountModel.Actor = buildActor(account.Actor)
1685 channelModel.Account = accountModel
1687 const videoModel = new VideoModel(pick(row, videoKeys))
1688 videoModel.VideoChannel = channelModel
1690 videoModel.UserVideoHistories = []
1691 videoModel.Thumbnails = []
1692 videoModel.VideoFiles = []
1693 videoModel.VideoStreamingPlaylists = []
1695 videosMemo[row.id] = videoModel
1696 // Don't take object value to have a sorted array
1697 videos.push(videoModel)
1700 const videoModel = videosMemo[row.id]
1702 if (row.userVideoHistory?.id && !historyDone.has(row.userVideoHistory.id)) {
1703 const historyModel = new UserVideoHistoryModel(pick(row.userVideoHistory, [ 'id', 'currentTime' ]))
1704 videoModel.UserVideoHistories.push(historyModel)
1706 historyDone.add(row.userVideoHistory.id)
1709 if (row.Thumbnails?.id && !thumbnailsDone.has(row.Thumbnails.id)) {
1710 const thumbnailModel = new ThumbnailModel(pick(row.Thumbnails, [ 'id', 'type', 'filename' ]))
1711 videoModel.Thumbnails.push(thumbnailModel)
1713 thumbnailsDone.add(row.Thumbnails.id)
1716 if (row.VideoFiles?.id && !videoFilesDone.has(row.VideoFiles.id)) {
1717 const videoFileModel = new VideoFileModel(pick(row.VideoFiles, videoFileKeys))
1718 videoModel.VideoFiles.push(videoFileModel)
1720 videoFilesDone.add(row.VideoFiles.id)
1723 if (row.VideoStreamingPlaylists?.id && !videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]) {
1724 const streamingPlaylist = new VideoStreamingPlaylistModel(pick(row.VideoStreamingPlaylists, videoStreamingPlaylistKeys))
1725 streamingPlaylist.VideoFiles = []
1727 videoModel.VideoStreamingPlaylists.push(streamingPlaylist)
1729 videoStreamingPlaylistMemo[streamingPlaylist.id] = streamingPlaylist
1732 if (row.VideoStreamingPlaylists?.VideoFiles?.id && !videoFilesDone.has(row.VideoStreamingPlaylists.VideoFiles.id)) {
1733 const streamingPlaylist = videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]
1735 const videoFileModel = new VideoFileModel(pick(row.VideoStreamingPlaylists.VideoFiles, videoFileKeys))
1736 streamingPlaylist.VideoFiles.push(videoFileModel)
1738 videoFilesDone.add(row.VideoStreamingPlaylists.VideoFiles.id)
1745 static getCategoryLabel (id: number) {
1746 return VIDEO_CATEGORIES[id] || 'Misc'
1749 static getLicenceLabel (id: number) {
1750 return VIDEO_LICENCES[id] || 'Unknown'
1753 static getLanguageLabel (id: string) {
1754 return VIDEO_LANGUAGES[id] || 'Unknown'
1757 static getPrivacyLabel (id: number) {
1758 return VIDEO_PRIVACIES[id] || 'Unknown'
1761 static getStateLabel (id: number) {
1762 return VIDEO_STATES[id] || 'Unknown'
1766 return !!this.VideoBlacklist
1770 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1773 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1774 // We first transcode to WebTorrent format, so try this array first
1775 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
1776 const file = fun(this.VideoFiles, file => file.resolution)
1778 return Object.assign(file, { Video: this })
1781 // No webtorrent files, try with streaming playlist files
1782 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1783 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1785 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
1786 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1792 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1793 return this.getQualityFileBy(maxBy)
1796 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1797 return this.getQualityFileBy(minBy)
1800 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1801 if (Array.isArray(this.VideoFiles) === false) return undefined
1803 const file = this.VideoFiles.find(f => f.resolution === resolution)
1804 if (!file) return undefined
1806 return Object.assign(file, { Video: this })
1809 hasWebTorrentFiles () {
1810 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1813 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction: Transaction) {
1814 thumbnail.videoId = this.id
1816 const savedThumbnail = await thumbnail.save({ transaction })
1818 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1820 // Already have this thumbnail, skip
1821 if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return
1823 this.Thumbnails.push(savedThumbnail)
1826 generateThumbnailName () {
1827 return this.uuid + '.jpg'
1831 if (Array.isArray(this.Thumbnails) === false) return undefined
1833 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1836 generatePreviewName () {
1837 return this.uuid + '.jpg'
1841 return !!this.getPreview()
1845 if (Array.isArray(this.Thumbnails) === false) return undefined
1847 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1851 return this.remote === false
1854 getWatchStaticPath () {
1855 return '/videos/watch/' + this.uuid
1858 getEmbedStaticPath () {
1859 return '/videos/embed/' + this.uuid
1862 getMiniatureStaticPath () {
1863 const thumbnail = this.getMiniature()
1864 if (!thumbnail) return null
1866 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1869 getPreviewStaticPath () {
1870 const preview = this.getPreview()
1871 if (!preview) return null
1873 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1874 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1877 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1878 return videoModelToFormattedJSON(this, options)
1881 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1882 return videoModelToFormattedDetailsJSON(this)
1885 getFormattedVideoFilesJSON (): VideoFile[] {
1886 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1887 let files: VideoFile[] = []
1889 if (Array.isArray(this.VideoFiles)) {
1890 const result = videoFilesModelToFormattedJSON(this, baseUrlHttp, baseUrlWs, this.VideoFiles)
1891 files = files.concat(result)
1894 for (const p of (this.VideoStreamingPlaylists || [])) {
1897 const result = videoFilesModelToFormattedJSON(p, baseUrlHttp, baseUrlWs, p.VideoFiles)
1898 files = files.concat(result)
1904 toActivityPubObject (this: MVideoAP): VideoObject {
1905 return videoModelToActivityPubObject(this)
1908 getTruncatedDescription () {
1909 if (!this.description) return null
1911 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1912 return peertubeTruncate(this.description, { length: maxLength })
1915 getMaxQualityResolution () {
1916 const file = this.getMaxQualityFile()
1917 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1918 const originalFilePath = getVideoFilePath(videoOrPlaylist, file)
1920 return getVideoFileResolution(originalFilePath)
1923 getDescriptionAPIPath () {
1924 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1927 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1928 if (!this.VideoStreamingPlaylists) return undefined
1930 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1931 playlist.Video = this
1936 setHLSPlaylist (playlist: MStreamingPlaylist) {
1937 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1939 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1940 this.VideoStreamingPlaylists = toAdd
1944 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1945 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1949 removeFile (videoFile: MVideoFile, isRedundancy = false) {
1950 const filePath = getVideoFilePath(this, videoFile, isRedundancy)
1951 return remove(filePath)
1952 .catch(err => logger.warn('Cannot delete file %s.', filePath, { err }))
1955 removeTorrent (videoFile: MVideoFile) {
1956 const torrentPath = getTorrentFilePath(this, videoFile)
1957 return remove(torrentPath)
1958 .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
1961 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1962 const directoryPath = getHLSDirectory(this, isRedundancy)
1964 await remove(directoryPath)
1966 if (isRedundancy !== true) {
1967 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1968 streamingPlaylistWithFiles.Video = this
1970 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1971 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1974 // Remove physical files and torrents
1976 streamingPlaylistWithFiles.VideoFiles.map(file => streamingPlaylistWithFiles.removeTorrent(file))
1982 if (this.isOwned()) return false
1984 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1987 hasPrivacyForFederation () {
1988 return isPrivacyForFederation(this.privacy)
1991 hasStateForFederation () {
1992 return isStateForFederation(this.state)
1995 isNewVideo (newPrivacy: VideoPrivacy) {
1996 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
2000 this.changed('updatedAt', true)
2006 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
2009 setPrivacy (newPrivacy: VideoPrivacy) {
2010 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
2011 this.publishedAt = new Date()
2014 this.privacy = newPrivacy
2018 return this.privacy === VideoPrivacy.PRIVATE ||
2019 this.privacy === VideoPrivacy.UNLISTED ||
2020 this.privacy === VideoPrivacy.INTERNAL
2023 async publishIfNeededAndSave (t: Transaction) {
2024 if (this.state !== VideoState.PUBLISHED) {
2025 this.state = VideoState.PUBLISHED
2026 this.publishedAt = new Date()
2027 await this.save({ transaction: t })
2036 if (this.isOwned()) {
2038 baseUrlHttp: WEBSERVER.URL,
2039 baseUrlWs: WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT
2044 baseUrlHttp: REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host,
2045 baseUrlWs: REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
2049 getTrackerUrls (baseUrlHttp: string, baseUrlWs: string) {
2050 return [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
2053 getTorrentUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2054 return baseUrlHttp + STATIC_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
2057 getTorrentDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2058 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
2061 getVideoFileUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2062 return baseUrlHttp + STATIC_PATHS.WEBSEED + getVideoFilename(this, videoFile)
2065 getVideoFileMetadataUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2066 const path = '/api/v1/videos/'
2068 return this.isOwned()
2069 ? baseUrlHttp + path + this.uuid + '/metadata/' + videoFile.id
2070 : videoFile.metadataUrl
2073 getVideoRedundancyUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2074 return baseUrlHttp + STATIC_PATHS.REDUNDANCY + getVideoFilename(this, videoFile)
2077 getVideoFileDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2078 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + getVideoFilename(this, videoFile)
2081 getBandwidthBits (videoFile: MVideoFile) {
2082 return Math.ceil((videoFile.size * 8) / this.duration)