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, 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/ffmpeg-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'
133 export enum ScopeNames {
134 AVAILABLE_FOR_LIST_IDS = 'AVAILABLE_FOR_LIST_IDS',
136 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
137 WITH_TAGS = 'WITH_TAGS',
138 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
139 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
140 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
141 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
142 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
143 WITH_USER_ID = 'WITH_USER_ID',
144 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
145 WITH_THUMBNAILS = 'WITH_THUMBNAILS',
146 WITH_LIVE = 'WITH_LIVE'
149 export type ForAPIOptions = {
152 videoPlaylistId?: number
156 withAccountBlockerIds?: number[]
159 export type AvailableForListIDsOptions = {
160 serverAccountId: number
161 followerActorId: number
162 includeLocalVideos: boolean
164 attributesType?: 'none' | 'id' | 'all'
167 categoryOneOf?: number[]
169 licenceOneOf?: number[]
170 languageOneOf?: string[]
177 videoChannelId?: number
179 videoPlaylistId?: number
181 trendingDays?: number
182 user?: MUserAccountId
183 historyOfUser?: MUserId
185 baseWhere?: WhereOptions[]
189 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
190 attributes: [ 'id', 'url', 'uuid', 'remote' ]
192 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
193 const query: FindOptions = {
196 model: VideoChannelModel.scope({
198 VideoChannelScopeNames.SUMMARY, {
200 withAccountBlockerIds: options.withAccountBlockerIds
207 attributes: [ 'type', 'filename' ],
208 model: ThumbnailModel,
222 if (options.withFiles === true) {
224 model: VideoFileModel,
229 if (options.videoPlaylistId) {
231 model: VideoPlaylistElementModel.unscoped(),
234 videoPlaylistId: options.videoPlaylistId
241 [ScopeNames.WITH_THUMBNAILS]: {
244 model: ThumbnailModel,
249 [ScopeNames.WITH_LIVE]: {
252 model: VideoLiveModel.unscoped(),
257 [ScopeNames.WITH_USER_ID]: {
260 attributes: [ 'accountId' ],
261 model: VideoChannelModel.unscoped(),
265 attributes: [ 'userId' ],
266 model: AccountModel.unscoped(),
273 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
276 model: VideoChannelModel.unscoped(),
281 exclude: [ 'privateKey', 'publicKey' ]
283 model: ActorModel.unscoped(),
287 attributes: [ 'host' ],
288 model: ServerModel.unscoped(),
292 model: AvatarModel.unscoped(),
298 model: AccountModel.unscoped(),
302 model: ActorModel.unscoped(),
304 exclude: [ 'privateKey', 'publicKey' ]
309 attributes: [ 'host' ],
310 model: ServerModel.unscoped(),
314 model: AvatarModel.unscoped(),
325 [ScopeNames.WITH_TAGS]: {
326 include: [ TagModel ]
328 [ScopeNames.WITH_BLACKLISTED]: {
331 attributes: [ 'id', 'reason', 'unfederated' ],
332 model: VideoBlacklistModel,
337 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
338 let subInclude: any[] = []
340 if (withRedundancies === true) {
343 attributes: [ 'fileUrl' ],
344 model: VideoRedundancyModel.unscoped(),
353 model: VideoFileModel,
354 separate: true, // We may have multiple files, having multiple redundancies so let's separate this join
361 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
362 const subInclude: IncludeOptions[] = [
364 model: VideoFileModel,
369 if (withRedundancies === true) {
371 attributes: [ 'fileUrl' ],
372 model: VideoRedundancyModel.unscoped(),
380 model: VideoStreamingPlaylistModel.unscoped(),
381 separate: true, // We may have multiple streaming playlists, having multiple redundancies so let's separate this join
388 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
391 model: ScheduleVideoUpdateModel.unscoped(),
396 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
400 attributes: [ 'currentTime' ],
401 model: UserVideoHistoryModel.unscoped(),
414 buildTrigramSearchIndex('video_name_trigram', 'name'),
416 { fields: [ 'createdAt' ] },
419 { name: 'publishedAt', order: 'DESC' },
420 { name: 'id', order: 'ASC' }
423 { fields: [ 'duration' ] },
424 { fields: [ 'views' ] },
425 { fields: [ 'channelId' ] },
427 fields: [ 'originallyPublishedAt' ],
429 originallyPublishedAt: {
435 fields: [ 'category' ], // We don't care videos with an unknown category
443 fields: [ 'licence' ], // We don't care videos with an unknown licence
451 fields: [ 'language' ], // We don't care videos with an unknown language
459 fields: [ 'nsfw' ], // Most of the videos are not NSFW
465 fields: [ 'remote' ], // Only index local videos
480 export class VideoModel extends Model<VideoModel> {
483 @Default(DataType.UUIDV4)
485 @Column(DataType.UUID)
489 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
495 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category', true))
501 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence', true))
507 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language', true))
508 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
512 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
514 privacy: VideoPrivacy
517 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
523 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
524 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
529 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
530 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
534 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
569 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
570 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
575 commentsEnabled: boolean
579 downloadEnabled: boolean
583 waitTranscoding: boolean
587 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
598 @Default(DataType.NOW)
605 originallyPublishedAt: Date
607 @ForeignKey(() => VideoChannelModel)
611 @BelongsTo(() => VideoChannelModel, {
617 VideoChannel: VideoChannelModel
619 @BelongsToMany(() => TagModel, {
620 foreignKey: 'videoId',
621 through: () => VideoTagModel,
626 @HasMany(() => ThumbnailModel, {
634 Thumbnails: ThumbnailModel[]
636 @HasMany(() => VideoPlaylistElementModel, {
643 VideoPlaylistElements: VideoPlaylistElementModel[]
645 @HasMany(() => VideoAbuseModel, {
652 VideoAbuses: VideoAbuseModel[]
654 @HasMany(() => VideoFileModel, {
662 VideoFiles: VideoFileModel[]
664 @HasMany(() => VideoStreamingPlaylistModel, {
672 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
674 @HasMany(() => VideoShareModel, {
681 VideoShares: VideoShareModel[]
683 @HasMany(() => AccountVideoRateModel, {
690 AccountVideoRates: AccountVideoRateModel[]
692 @HasMany(() => VideoCommentModel, {
700 VideoComments: VideoCommentModel[]
702 @HasMany(() => VideoViewModel, {
709 VideoViews: VideoViewModel[]
711 @HasMany(() => UserVideoHistoryModel, {
718 UserVideoHistories: UserVideoHistoryModel[]
720 @HasOne(() => ScheduleVideoUpdateModel, {
727 ScheduleVideoUpdate: ScheduleVideoUpdateModel
729 @HasOne(() => VideoBlacklistModel, {
736 VideoBlacklist: VideoBlacklistModel
738 @HasOne(() => VideoLiveModel, {
745 VideoLive: VideoLiveModel
747 @HasOne(() => VideoImportModel, {
754 VideoImport: VideoImportModel
756 @HasMany(() => VideoCaptionModel, {
763 ['separate' as any]: true
765 VideoCaptions: VideoCaptionModel[]
768 static async sendDelete (instance: MVideoAccountLight, options) {
769 if (instance.isOwned()) {
770 if (!instance.VideoChannel) {
771 instance.VideoChannel = await instance.$get('VideoChannel', {
776 transaction: options.transaction
777 }) as MChannelAccountDefault
780 return sendDeleteVideo(instance, options.transaction)
787 static async removeFiles (instance: VideoModel) {
788 const tasks: Promise<any>[] = []
790 logger.info('Removing files of video %s.', instance.url)
792 if (instance.isOwned()) {
793 if (!Array.isArray(instance.VideoFiles)) {
794 instance.VideoFiles = await instance.$get('VideoFiles')
797 // Remove physical files and torrents
798 instance.VideoFiles.forEach(file => {
799 tasks.push(instance.removeFile(file))
800 tasks.push(instance.removeTorrent(file))
803 // Remove playlists file
804 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
805 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists')
808 for (const p of instance.VideoStreamingPlaylists) {
809 tasks.push(instance.removeStreamingPlaylistFiles(p))
813 // Do not wait video deletion because we could be in a transaction
816 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
823 static stopLiveIfNeeded (instance: VideoModel) {
824 if (!instance.isLive) return
826 logger.info('Stopping live of video %s after video deletion.', instance.uuid)
828 return LiveManager.Instance.stopSessionOf(instance.id)
832 static invalidateCache (instance: VideoModel) {
833 ModelCache.Instance.invalidateCache('video', instance.id)
837 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
838 const tasks: Promise<any>[] = []
840 if (!Array.isArray(instance.VideoAbuses)) {
841 instance.VideoAbuses = await instance.$get('VideoAbuses')
843 if (instance.VideoAbuses.length === 0) return undefined
846 logger.info('Saving video abuses details of video %s.', instance.url)
848 const details = instance.toFormattedDetailsJSON()
850 for (const abuse of instance.VideoAbuses) {
851 abuse.deletedVideo = details
852 tasks.push(abuse.save({ transaction: options.transaction }))
857 logger.error('Some errors when saving details of video %s in its abuses before destroy hook.', instance.uuid, { err })
863 static listLocal (): Bluebird<MVideoWithAllFiles[]> {
870 return VideoModel.scope([
871 ScopeNames.WITH_WEBTORRENT_FILES,
872 ScopeNames.WITH_STREAMING_PLAYLISTS,
873 ScopeNames.WITH_THUMBNAILS
877 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
878 function getRawQuery (select: string) {
879 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
880 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
881 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
882 'WHERE "Account"."actorId" = ' + actorId
883 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
884 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
885 'WHERE "VideoShare"."actorId" = ' + actorId
887 return `(${queryVideo}) UNION (${queryVideoShare})`
890 const rawQuery = getRawQuery('"Video"."id"')
891 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
897 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ] as any), // FIXME: sequelize typings
900 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
902 [Op.or]: getPrivaciesForFederation()
906 attributes: [ 'language', 'fileUrl' ],
907 model: VideoCaptionModel.unscoped(),
911 attributes: [ 'id', 'url' ],
912 model: VideoShareModel.unscoped(),
914 // We only want videos shared by this actor
929 attributes: [ 'id', 'url' ],
930 model: ActorModel.unscoped()
935 model: VideoChannelModel.unscoped(),
939 attributes: [ 'name' ],
940 model: AccountModel.unscoped(),
944 attributes: [ 'id', 'url', 'followersUrl' ],
945 model: ActorModel.unscoped(),
951 attributes: [ 'id', 'url', 'followersUrl' ],
952 model: ActorModel.unscoped(),
958 model: VideoStreamingPlaylistModel.unscoped(),
962 model: VideoFileModel,
967 VideoLiveModel.unscoped(),
973 return Bluebird.all([
974 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
975 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
976 ]).then(([ rows, totals ]) => {
977 // totals: totalVideos + totalVideoShares
979 let totalVideoShares = 0
980 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
981 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
983 const total = totalVideos + totalVideoShares
991 static listPublishedLiveIds () {
993 attributes: [ 'id' ],
996 state: VideoState.PUBLISHED
1000 return VideoModel.findAll(options)
1004 static listUserVideosForApi (
1011 function buildBaseQuery (): FindOptions {
1015 order: getVideoSort(sort),
1018 model: VideoChannelModel,
1022 model: AccountModel,
1034 baseQuery = Object.assign(baseQuery, {
1037 [Op.iLike]: '%' + search + '%'
1046 const countQuery = buildBaseQuery()
1047 const findQuery = buildBaseQuery()
1049 const findScopes: (string | ScopeOptions)[] = [
1050 ScopeNames.WITH_SCHEDULED_UPDATE,
1051 ScopeNames.WITH_BLACKLISTED,
1052 ScopeNames.WITH_THUMBNAILS
1055 return Promise.all([
1056 VideoModel.count(countQuery),
1057 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
1058 ]).then(([ count, rows ]) => {
1066 static async listForApi (options: {
1071 includeLocalVideos: boolean
1073 categoryOneOf?: number[]
1074 licenceOneOf?: number[]
1075 languageOneOf?: string[]
1076 tagsOneOf?: string[]
1077 tagsAllOf?: string[]
1078 filter?: VideoFilter
1080 videoChannelId?: number
1081 followerActorId?: number
1082 videoPlaylistId?: number
1083 trendingDays?: number
1084 user?: MUserAccountId
1085 historyOfUser?: MUserId
1086 countVideos?: boolean
1088 if (options.filter && options.filter === 'all-local' && !options.user.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1089 throw new Error('Try to filter all-local but no user has not the see all videos right')
1092 const trendingDays = options.sort.endsWith('trending')
1093 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1096 const serverActor = await getServerActor()
1098 // followerActorId === null has a meaning, so just check undefined
1099 const followerActorId = options.followerActorId !== undefined
1100 ? options.followerActorId
1103 const queryOptions = {
1104 start: options.start,
1105 count: options.count,
1108 serverAccountId: serverActor.Account.id,
1110 categoryOneOf: options.categoryOneOf,
1111 licenceOneOf: options.licenceOneOf,
1112 languageOneOf: options.languageOneOf,
1113 tagsOneOf: options.tagsOneOf,
1114 tagsAllOf: options.tagsAllOf,
1115 filter: options.filter,
1116 withFiles: options.withFiles,
1117 accountId: options.accountId,
1118 videoChannelId: options.videoChannelId,
1119 videoPlaylistId: options.videoPlaylistId,
1120 includeLocalVideos: options.includeLocalVideos,
1122 historyOfUser: options.historyOfUser,
1126 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
1129 static async searchAndPopulateAccountAndServer (options: {
1130 includeLocalVideos: boolean
1135 startDate?: string // ISO 8601
1136 endDate?: string // ISO 8601
1137 originallyPublishedStartDate?: string
1138 originallyPublishedEndDate?: string
1140 categoryOneOf?: number[]
1141 licenceOneOf?: number[]
1142 languageOneOf?: string[]
1143 tagsOneOf?: string[]
1144 tagsAllOf?: string[]
1145 durationMin?: number // seconds
1146 durationMax?: number // seconds
1147 user?: MUserAccountId
1148 filter?: VideoFilter
1150 const serverActor = await getServerActor()
1151 const queryOptions = {
1152 followerActorId: serverActor.id,
1153 serverAccountId: serverActor.Account.id,
1154 includeLocalVideos: options.includeLocalVideos,
1156 categoryOneOf: options.categoryOneOf,
1157 licenceOneOf: options.licenceOneOf,
1158 languageOneOf: options.languageOneOf,
1159 tagsOneOf: options.tagsOneOf,
1160 tagsAllOf: options.tagsAllOf,
1162 filter: options.filter,
1163 start: options.start,
1164 count: options.count,
1166 startDate: options.startDate,
1167 endDate: options.endDate,
1168 originallyPublishedStartDate: options.originallyPublishedStartDate,
1169 originallyPublishedEndDate: options.originallyPublishedEndDate,
1171 durationMin: options.durationMin,
1172 durationMax: options.durationMax,
1174 search: options.search
1177 return VideoModel.getAvailableForApi(queryOptions)
1180 static countLocalLives () {
1188 return VideoModel.count(options)
1191 static countLivesOfAccount (accountId: number) {
1200 model: VideoChannelModel.unscoped(),
1208 return VideoModel.count(options)
1211 static load (id: number | string, t?: Transaction): Bluebird<MVideoThumbnail> {
1212 const where = buildWhereIdOrUUID(id)
1218 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1221 static loadWithBlacklist (id: number | string, t?: Transaction): Bluebird<MVideoThumbnailBlacklist> {
1222 const where = buildWhereIdOrUUID(id)
1228 return VideoModel.scope([
1229 ScopeNames.WITH_THUMBNAILS,
1230 ScopeNames.WITH_BLACKLISTED
1234 static loadImmutableAttributes (id: number | string, t?: Transaction): Bluebird<MVideoImmutable> {
1237 where: buildWhereIdOrUUID(id),
1241 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1244 return ModelCache.Instance.doCache({
1245 cacheType: 'load-video-immutable-id',
1252 static loadWithRights (id: number | string, t?: Transaction): Bluebird<MVideoWithRights> {
1253 const where = buildWhereIdOrUUID(id)
1259 return VideoModel.scope([
1260 ScopeNames.WITH_BLACKLISTED,
1261 ScopeNames.WITH_USER_ID,
1262 ScopeNames.WITH_THUMBNAILS
1266 static loadOnlyId (id: number | string, t?: Transaction): Bluebird<MVideoIdThumbnail> {
1267 const where = buildWhereIdOrUUID(id)
1270 attributes: [ 'id' ],
1275 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1278 static loadWithFiles (id: number | string, t?: Transaction, logging?: boolean): Bluebird<MVideoWithAllFiles> {
1279 const where = buildWhereIdOrUUID(id)
1287 return VideoModel.scope([
1288 ScopeNames.WITH_WEBTORRENT_FILES,
1289 ScopeNames.WITH_STREAMING_PLAYLISTS,
1290 ScopeNames.WITH_THUMBNAILS
1294 static loadByUUID (uuid: string): Bluebird<MVideoThumbnail> {
1301 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1304 static loadByUrl (url: string, transaction?: Transaction): Bluebird<MVideoThumbnail> {
1305 const query: FindOptions = {
1312 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(query)
1315 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Bluebird<MVideoImmutable> {
1317 const query: FindOptions = {
1324 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1327 return ModelCache.Instance.doCache({
1328 cacheType: 'load-video-immutable-url',
1335 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Bluebird<MVideoAccountLightBlacklistAllFiles> {
1336 const query: FindOptions = {
1343 return VideoModel.scope([
1344 ScopeNames.WITH_ACCOUNT_DETAILS,
1345 ScopeNames.WITH_WEBTORRENT_FILES,
1346 ScopeNames.WITH_STREAMING_PLAYLISTS,
1347 ScopeNames.WITH_THUMBNAILS,
1348 ScopeNames.WITH_BLACKLISTED
1352 static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Bluebird<MVideoFullLight> {
1353 const where = buildWhereIdOrUUID(id)
1356 order: [ [ 'Tags', 'name', 'ASC' ] ] as any,
1361 const scopes: (string | ScopeOptions)[] = [
1362 ScopeNames.WITH_TAGS,
1363 ScopeNames.WITH_BLACKLISTED,
1364 ScopeNames.WITH_ACCOUNT_DETAILS,
1365 ScopeNames.WITH_SCHEDULED_UPDATE,
1366 ScopeNames.WITH_WEBTORRENT_FILES,
1367 ScopeNames.WITH_STREAMING_PLAYLISTS,
1368 ScopeNames.WITH_THUMBNAILS,
1369 ScopeNames.WITH_LIVE
1373 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1381 static loadForGetAPI (parameters: {
1385 }): Bluebird<MVideoDetails> {
1386 const { id, t, userId } = parameters
1387 const where = buildWhereIdOrUUID(id)
1390 order: [ [ 'Tags', 'name', 'ASC' ] ] as any, // FIXME: sequelize typings
1395 const scopes: (string | ScopeOptions)[] = [
1396 ScopeNames.WITH_TAGS,
1397 ScopeNames.WITH_BLACKLISTED,
1398 ScopeNames.WITH_ACCOUNT_DETAILS,
1399 ScopeNames.WITH_SCHEDULED_UPDATE,
1400 ScopeNames.WITH_THUMBNAILS,
1401 ScopeNames.WITH_LIVE,
1402 { method: [ ScopeNames.WITH_WEBTORRENT_FILES, true ] },
1403 { method: [ ScopeNames.WITH_STREAMING_PLAYLISTS, true ] }
1407 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1415 static async getStats () {
1416 const totalLocalVideos = await VideoModel.count({
1422 let totalLocalVideoViews = await VideoModel.sum('views', {
1428 // Sequelize could return null...
1429 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1431 const { total: totalVideos } = await VideoModel.listForApi({
1434 sort: '-publishedAt',
1435 nsfw: buildNSFWFilter(),
1436 includeLocalVideos: true,
1442 totalLocalVideoViews,
1447 static incrementViews (id: number, views: number) {
1448 return VideoModel.increment('views', {
1456 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1457 // Instances only share videos
1458 const query = 'SELECT 1 FROM "videoShare" ' +
1459 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1460 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1464 type: QueryTypes.SELECT as QueryTypes.SELECT,
1465 bind: { followerActorId, videoId },
1469 return VideoModel.sequelize.query(query, options)
1470 .then(results => results.length === 1)
1473 static bulkUpdateSupportField (videoChannel: MChannel, t: Transaction) {
1476 channelId: videoChannel.id
1481 return VideoModel.update({ support: videoChannel.support }, options)
1484 static getAllIdsFromChannel (videoChannel: MChannelId): Bluebird<number[]> {
1486 attributes: [ 'id' ],
1488 channelId: videoChannel.id
1492 return VideoModel.findAll(query)
1493 .then(videos => videos.map(v => v.id))
1496 // threshold corresponds to how many video the field should have to be returned
1497 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1498 const serverActor = await getServerActor()
1499 const followerActorId = serverActor.id
1501 const queryOptions: BuildVideosQueryOptions = {
1502 attributes: [ `"${field}"` ],
1503 group: `GROUP BY "${field}"`,
1504 having: `HAVING COUNT("${field}") >= ${threshold}`,
1508 serverAccountId: serverActor.Account.id,
1510 includeLocalVideos: true
1513 const { query, replacements } = buildListQuery(VideoModel, queryOptions)
1515 return this.sequelize.query<any>(query, { replacements, type: QueryTypes.SELECT })
1516 .then(rows => rows.map(r => r[field]))
1519 static buildTrendingQuery (trendingDays: number) {
1523 model: VideoViewModel,
1527 [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1533 private static async getAvailableForApi (
1534 options: BuildVideosQueryOptions,
1536 ): Promise<ResultList<VideoModel>> {
1537 function getCount () {
1538 if (countVideos !== true) return Promise.resolve(undefined)
1540 const countOptions = Object.assign({}, options, { isCount: true })
1541 const { query: queryCount, replacements: replacementsCount } = buildListQuery(VideoModel, countOptions)
1543 return VideoModel.sequelize.query<any>(queryCount, { replacements: replacementsCount, type: QueryTypes.SELECT })
1544 .then(rows => rows.length !== 0 ? rows[0].total : 0)
1547 function getModels () {
1548 if (options.count === 0) return Promise.resolve([])
1550 const { query, replacements, order } = buildListQuery(VideoModel, options)
1551 const queryModels = wrapForAPIResults(query, replacements, options, order)
1553 return VideoModel.sequelize.query<any>(queryModels, { replacements, type: QueryTypes.SELECT, nest: true })
1554 .then(rows => VideoModel.buildAPIResult(rows))
1557 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1565 private static buildAPIResult (rows: any[]) {
1566 const videosMemo: { [ id: number ]: VideoModel } = {}
1567 const videoStreamingPlaylistMemo: { [ id: number ]: VideoStreamingPlaylistModel } = {}
1569 const thumbnailsDone = new Set<number>()
1570 const historyDone = new Set<number>()
1571 const videoFilesDone = new Set<number>()
1573 const videos: VideoModel[] = []
1575 const avatarKeys = [ 'id', 'filename', 'fileUrl', 'onDisk', 'createdAt', 'updatedAt' ]
1576 const actorKeys = [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ]
1577 const serverKeys = [ 'id', 'host' ]
1578 const videoFileKeys = [ 'id', 'createdAt', 'updatedAt', 'resolution', 'size', 'extname', 'infoHash', 'fps', 'videoId' ]
1579 const videoStreamingPlaylistKeys = [ 'id' ]
1602 'originallyPublishedAt',
1608 function buildActor (rowActor: any) {
1609 const avatarModel = rowActor.Avatar.id !== null
1610 ? new AvatarModel(pick(rowActor.Avatar, avatarKeys))
1613 const serverModel = rowActor.Server.id !== null
1614 ? new ServerModel(pick(rowActor.Server, serverKeys))
1617 const actorModel = new ActorModel(pick(rowActor, actorKeys))
1618 actorModel.Avatar = avatarModel
1619 actorModel.Server = serverModel
1624 for (const row of rows) {
1625 if (!videosMemo[row.id]) {
1627 const channel = row.VideoChannel
1628 const channelModel = new VideoChannelModel(pick(channel, [ 'id', 'name', 'description', 'actorId' ]))
1629 channelModel.Actor = buildActor(channel.Actor)
1631 const account = row.VideoChannel.Account
1632 const accountModel = new AccountModel(pick(account, [ 'id', 'name' ]))
1633 accountModel.Actor = buildActor(account.Actor)
1635 channelModel.Account = accountModel
1637 const videoModel = new VideoModel(pick(row, videoKeys))
1638 videoModel.VideoChannel = channelModel
1640 videoModel.UserVideoHistories = []
1641 videoModel.Thumbnails = []
1642 videoModel.VideoFiles = []
1643 videoModel.VideoStreamingPlaylists = []
1645 videosMemo[row.id] = videoModel
1646 // Don't take object value to have a sorted array
1647 videos.push(videoModel)
1650 const videoModel = videosMemo[row.id]
1652 if (row.userVideoHistory?.id && !historyDone.has(row.userVideoHistory.id)) {
1653 const historyModel = new UserVideoHistoryModel(pick(row.userVideoHistory, [ 'id', 'currentTime' ]))
1654 videoModel.UserVideoHistories.push(historyModel)
1656 historyDone.add(row.userVideoHistory.id)
1659 if (row.Thumbnails?.id && !thumbnailsDone.has(row.Thumbnails.id)) {
1660 const thumbnailModel = new ThumbnailModel(pick(row.Thumbnails, [ 'id', 'type', 'filename' ]))
1661 videoModel.Thumbnails.push(thumbnailModel)
1663 thumbnailsDone.add(row.Thumbnails.id)
1666 if (row.VideoFiles?.id && !videoFilesDone.has(row.VideoFiles.id)) {
1667 const videoFileModel = new VideoFileModel(pick(row.VideoFiles, videoFileKeys))
1668 videoModel.VideoFiles.push(videoFileModel)
1670 videoFilesDone.add(row.VideoFiles.id)
1673 if (row.VideoStreamingPlaylists?.id && !videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]) {
1674 const streamingPlaylist = new VideoStreamingPlaylistModel(pick(row.VideoStreamingPlaylists, videoStreamingPlaylistKeys))
1675 streamingPlaylist.VideoFiles = []
1677 videoModel.VideoStreamingPlaylists.push(streamingPlaylist)
1679 videoStreamingPlaylistMemo[streamingPlaylist.id] = streamingPlaylist
1682 if (row.VideoStreamingPlaylists?.VideoFiles?.id && !videoFilesDone.has(row.VideoStreamingPlaylists.VideoFiles.id)) {
1683 const streamingPlaylist = videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]
1685 const videoFileModel = new VideoFileModel(pick(row.VideoStreamingPlaylists.VideoFiles, videoFileKeys))
1686 streamingPlaylist.VideoFiles.push(videoFileModel)
1688 videoFilesDone.add(row.VideoStreamingPlaylists.VideoFiles.id)
1695 static getCategoryLabel (id: number) {
1696 return VIDEO_CATEGORIES[id] || 'Misc'
1699 static getLicenceLabel (id: number) {
1700 return VIDEO_LICENCES[id] || 'Unknown'
1703 static getLanguageLabel (id: string) {
1704 return VIDEO_LANGUAGES[id] || 'Unknown'
1707 static getPrivacyLabel (id: number) {
1708 return VIDEO_PRIVACIES[id] || 'Unknown'
1711 static getStateLabel (id: number) {
1712 return VIDEO_STATES[id] || 'Unknown'
1716 return !!this.VideoBlacklist
1720 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1723 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1724 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
1725 const file = fun(this.VideoFiles, file => file.resolution)
1727 return Object.assign(file, { Video: this })
1730 // No webtorrent files, try with streaming playlist files
1731 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1732 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1734 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
1735 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1741 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1742 return this.getQualityFileBy(maxBy)
1745 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1746 return this.getQualityFileBy(minBy)
1749 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1750 if (Array.isArray(this.VideoFiles) === false) return undefined
1752 const file = this.VideoFiles.find(f => f.resolution === resolution)
1753 if (!file) return undefined
1755 return Object.assign(file, { Video: this })
1758 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction: Transaction) {
1759 thumbnail.videoId = this.id
1761 const savedThumbnail = await thumbnail.save({ transaction })
1763 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1765 // Already have this thumbnail, skip
1766 if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return
1768 this.Thumbnails.push(savedThumbnail)
1771 generateThumbnailName () {
1772 return this.uuid + '.jpg'
1776 if (Array.isArray(this.Thumbnails) === false) return undefined
1778 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1781 generatePreviewName () {
1782 return this.uuid + '.jpg'
1786 return !!this.getPreview()
1790 if (Array.isArray(this.Thumbnails) === false) return undefined
1792 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1796 return this.remote === false
1799 getWatchStaticPath () {
1800 return '/videos/watch/' + this.uuid
1803 getEmbedStaticPath () {
1804 return '/videos/embed/' + this.uuid
1807 getMiniatureStaticPath () {
1808 const thumbnail = this.getMiniature()
1809 if (!thumbnail) return null
1811 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1814 getPreviewStaticPath () {
1815 const preview = this.getPreview()
1816 if (!preview) return null
1818 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1819 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1822 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1823 return videoModelToFormattedJSON(this, options)
1826 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1827 return videoModelToFormattedDetailsJSON(this)
1830 getFormattedVideoFilesJSON (): VideoFile[] {
1831 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1832 let files: MVideoFileRedundanciesOpt[] = []
1834 if (Array.isArray(this.VideoFiles)) {
1835 files = files.concat(this.VideoFiles)
1838 for (const p of (this.VideoStreamingPlaylists || [])) {
1839 files = files.concat(p.VideoFiles || [])
1842 return videoFilesModelToFormattedJSON(this, baseUrlHttp, baseUrlWs, files)
1845 toActivityPubObject (this: MVideoAP): VideoObject {
1846 return videoModelToActivityPubObject(this)
1849 getTruncatedDescription () {
1850 if (!this.description) return null
1852 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1853 return peertubeTruncate(this.description, { length: maxLength })
1856 getMaxQualityResolution () {
1857 const file = this.getMaxQualityFile()
1858 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1859 const originalFilePath = getVideoFilePath(videoOrPlaylist, file)
1861 return getVideoFileResolution(originalFilePath)
1864 getDescriptionAPIPath () {
1865 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1868 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1869 if (!this.VideoStreamingPlaylists) return undefined
1871 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1872 playlist.Video = this
1877 setHLSPlaylist (playlist: MStreamingPlaylist) {
1878 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1880 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1881 this.VideoStreamingPlaylists = toAdd
1885 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1886 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1890 removeFile (videoFile: MVideoFile, isRedundancy = false) {
1891 const filePath = getVideoFilePath(this, videoFile, isRedundancy)
1892 return remove(filePath)
1893 .catch(err => logger.warn('Cannot delete file %s.', filePath, { err }))
1896 removeTorrent (videoFile: MVideoFile) {
1897 const torrentPath = getTorrentFilePath(this, videoFile)
1898 return remove(torrentPath)
1899 .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
1902 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1903 const directoryPath = getHLSDirectory(this, isRedundancy)
1905 await remove(directoryPath)
1907 if (isRedundancy !== true) {
1908 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1909 streamingPlaylistWithFiles.Video = this
1911 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1912 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1915 // Remove physical files and torrents
1917 streamingPlaylistWithFiles.VideoFiles.map(file => streamingPlaylistWithFiles.removeTorrent(file))
1923 if (this.isOwned()) return false
1925 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1928 hasPrivacyForFederation () {
1929 return isPrivacyForFederation(this.privacy)
1932 hasStateForFederation () {
1933 return isStateForFederation(this.state)
1936 isNewVideo (newPrivacy: VideoPrivacy) {
1937 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
1941 this.changed('updatedAt', true)
1947 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
1950 setPrivacy (newPrivacy: VideoPrivacy) {
1951 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
1952 this.publishedAt = new Date()
1955 this.privacy = newPrivacy
1959 return this.privacy === VideoPrivacy.PRIVATE ||
1960 this.privacy === VideoPrivacy.UNLISTED ||
1961 this.privacy === VideoPrivacy.INTERNAL
1964 async publishIfNeededAndSave (t: Transaction) {
1965 if (this.state !== VideoState.PUBLISHED) {
1966 this.state = VideoState.PUBLISHED
1967 this.publishedAt = new Date()
1968 await this.save({ transaction: t })
1977 if (this.isOwned()) {
1979 baseUrlHttp: WEBSERVER.URL,
1980 baseUrlWs: WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT
1985 baseUrlHttp: REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host,
1986 baseUrlWs: REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
1990 getTrackerUrls (baseUrlHttp: string, baseUrlWs: string) {
1991 return [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1994 getTorrentUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1995 return baseUrlHttp + STATIC_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
1998 getTorrentDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1999 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
2002 getVideoFileUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2003 return baseUrlHttp + STATIC_PATHS.WEBSEED + getVideoFilename(this, videoFile)
2006 getVideoFileMetadataUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2007 const path = '/api/v1/videos/'
2009 return this.isOwned()
2010 ? baseUrlHttp + path + this.uuid + '/metadata/' + videoFile.id
2011 : videoFile.metadataUrl
2014 getVideoRedundancyUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2015 return baseUrlHttp + STATIC_PATHS.REDUNDANCY + getVideoFilename(this, videoFile)
2018 getVideoFileDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
2019 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + getVideoFilename(this, videoFile)
2022 getBandwidthBits (videoFile: MVideoFile) {
2023 return Math.ceil((videoFile.size * 8) / this.duration)