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 } from '@server/helpers/video'
29 import { getHLSDirectory, getTorrentFileName, getTorrentFilePath, getVideoFilename, getVideoFilePath } from '@server/lib/video-paths'
30 import { getServerActor } from '@server/models/application/application'
31 import { ModelCache } from '@server/models/model-cache'
32 import { VideoFile } from '@shared/models/videos/video-file.model'
33 import { ResultList, UserRight, VideoPrivacy, VideoState } from '../../../shared'
34 import { VideoObject } from '../../../shared/models/activitypub/objects'
35 import { Video, VideoDetails } from '../../../shared/models/videos'
36 import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
37 import { VideoFilter } from '../../../shared/models/videos/video-query.type'
38 import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
39 import { peertubeTruncate } from '../../helpers/core-utils'
40 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
41 import { isBooleanValid } from '../../helpers/custom-validators/misc'
44 isVideoDescriptionValid,
52 } from '../../helpers/custom-validators/videos'
53 import { getVideoFileResolution } from '../../helpers/ffmpeg-utils'
54 import { logger } from '../../helpers/logger'
55 import { CONFIG } from '../../initializers/config'
62 STATIC_DOWNLOAD_PATHS,
70 } from '../../initializers/constants'
71 import { sendDeleteVideo } from '../../lib/activitypub/send'
74 MChannelAccountDefault,
77 MStreamingPlaylistFilesVideo,
81 MVideoAccountLightBlacklistAllFiles,
86 MVideoFormattableDetails,
92 MVideoThumbnailBlacklist,
96 } from '../../types/models'
97 import { MThumbnail } from '../../types/models/video/thumbnail'
98 import { MVideoFile, MVideoFileRedundanciesOpt, MVideoFileStreamingPlaylistVideo } from '../../types/models/video/video-file'
99 import { VideoAbuseModel } from '../abuse/video-abuse'
100 import { AccountModel } from '../account/account'
101 import { AccountVideoRateModel } from '../account/account-video-rate'
102 import { UserVideoHistoryModel } from '../account/user-video-history'
103 import { ActorModel } from '../activitypub/actor'
104 import { AvatarModel } from '../avatar/avatar'
105 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
106 import { ServerModel } from '../server/server'
107 import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils'
108 import { ScheduleVideoUpdateModel } from './schedule-video-update'
109 import { TagModel } from './tag'
110 import { ThumbnailModel } from './thumbnail'
111 import { VideoBlacklistModel } from './video-blacklist'
112 import { VideoCaptionModel } from './video-caption'
113 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
114 import { VideoCommentModel } from './video-comment'
115 import { VideoFileModel } from './video-file'
117 videoFilesModelToFormattedJSON,
118 VideoFormattingJSONOptions,
119 videoModelToActivityPubObject,
120 videoModelToFormattedDetailsJSON,
121 videoModelToFormattedJSON
122 } from './video-format-utils'
123 import { VideoImportModel } from './video-import'
124 import { VideoPlaylistElementModel } from './video-playlist-element'
125 import { buildListQuery, BuildVideosQueryOptions, wrapForAPIResults } from './video-query-builder'
126 import { VideoShareModel } from './video-share'
127 import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
128 import { VideoTagModel } from './video-tag'
129 import { VideoViewModel } from './video-view'
130 import { LiveManager } from '@server/lib/live-manager'
131 import { VideoLiveModel } from './video-live'
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'
148 export type ForAPIOptions = {
151 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 query: FindOptions = {
195 model: VideoChannelModel.scope({
197 VideoChannelScopeNames.SUMMARY, {
199 withAccountBlockerIds: options.withAccountBlockerIds
206 attributes: [ 'type', 'filename' ],
207 model: ThumbnailModel,
221 if (options.withFiles === true) {
223 model: VideoFileModel,
228 if (options.videoPlaylistId) {
230 model: VideoPlaylistElementModel.unscoped(),
233 videoPlaylistId: options.videoPlaylistId
240 [ScopeNames.WITH_THUMBNAILS]: {
243 model: ThumbnailModel,
248 [ScopeNames.WITH_USER_ID]: {
251 attributes: [ 'accountId' ],
252 model: VideoChannelModel.unscoped(),
256 attributes: [ 'userId' ],
257 model: AccountModel.unscoped(),
264 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
267 model: VideoChannelModel.unscoped(),
272 exclude: [ 'privateKey', 'publicKey' ]
274 model: ActorModel.unscoped(),
278 attributes: [ 'host' ],
279 model: ServerModel.unscoped(),
283 model: AvatarModel.unscoped(),
289 model: AccountModel.unscoped(),
293 model: ActorModel.unscoped(),
295 exclude: [ 'privateKey', 'publicKey' ]
300 attributes: [ 'host' ],
301 model: ServerModel.unscoped(),
305 model: AvatarModel.unscoped(),
316 [ScopeNames.WITH_TAGS]: {
317 include: [ TagModel ]
319 [ScopeNames.WITH_BLACKLISTED]: {
322 attributes: [ 'id', 'reason', 'unfederated' ],
323 model: VideoBlacklistModel,
328 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
329 let subInclude: any[] = []
331 if (withRedundancies === true) {
334 attributes: [ 'fileUrl' ],
335 model: VideoRedundancyModel.unscoped(),
344 model: VideoFileModel,
345 separate: true, // We may have multiple files, having multiple redundancies so let's separate this join
352 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
353 const subInclude: IncludeOptions[] = [
355 model: VideoFileModel,
360 if (withRedundancies === true) {
362 attributes: [ 'fileUrl' ],
363 model: VideoRedundancyModel.unscoped(),
371 model: VideoStreamingPlaylistModel.unscoped(),
372 separate: true, // We may have multiple streaming playlists, having multiple redundancies so let's separate this join
379 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
382 model: ScheduleVideoUpdateModel.unscoped(),
387 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
391 attributes: [ 'currentTime' ],
392 model: UserVideoHistoryModel.unscoped(),
405 buildTrigramSearchIndex('video_name_trigram', 'name'),
407 { fields: [ 'createdAt' ] },
410 { name: 'publishedAt', order: 'DESC' },
411 { name: 'id', order: 'ASC' }
414 { fields: [ 'duration' ] },
415 { fields: [ 'views' ] },
416 { fields: [ 'channelId' ] },
418 fields: [ 'originallyPublishedAt' ],
420 originallyPublishedAt: {
426 fields: [ 'category' ], // We don't care videos with an unknown category
434 fields: [ 'licence' ], // We don't care videos with an unknown licence
442 fields: [ 'language' ], // We don't care videos with an unknown language
450 fields: [ 'nsfw' ], // Most of the videos are not NSFW
456 fields: [ 'remote' ], // Only index local videos
471 export class VideoModel extends Model<VideoModel> {
474 @Default(DataType.UUIDV4)
476 @Column(DataType.UUID)
480 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
486 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category', true))
492 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence', true))
498 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language', true))
499 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
503 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
505 privacy: VideoPrivacy
508 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
514 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
515 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
520 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
521 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
525 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
560 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
561 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
566 commentsEnabled: boolean
570 downloadEnabled: boolean
574 waitTranscoding: boolean
578 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
589 @Default(DataType.NOW)
596 originallyPublishedAt: Date
598 @ForeignKey(() => VideoChannelModel)
602 @BelongsTo(() => VideoChannelModel, {
608 VideoChannel: VideoChannelModel
610 @BelongsToMany(() => TagModel, {
611 foreignKey: 'videoId',
612 through: () => VideoTagModel,
617 @HasMany(() => ThumbnailModel, {
625 Thumbnails: ThumbnailModel[]
627 @HasMany(() => VideoPlaylistElementModel, {
634 VideoPlaylistElements: VideoPlaylistElementModel[]
636 @HasMany(() => VideoAbuseModel, {
643 VideoAbuses: VideoAbuseModel[]
645 @HasMany(() => VideoFileModel, {
653 VideoFiles: VideoFileModel[]
655 @HasMany(() => VideoStreamingPlaylistModel, {
663 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
665 @HasMany(() => VideoShareModel, {
672 VideoShares: VideoShareModel[]
674 @HasMany(() => AccountVideoRateModel, {
681 AccountVideoRates: AccountVideoRateModel[]
683 @HasMany(() => VideoCommentModel, {
691 VideoComments: VideoCommentModel[]
693 @HasMany(() => VideoViewModel, {
700 VideoViews: VideoViewModel[]
702 @HasMany(() => UserVideoHistoryModel, {
709 UserVideoHistories: UserVideoHistoryModel[]
711 @HasOne(() => ScheduleVideoUpdateModel, {
718 ScheduleVideoUpdate: ScheduleVideoUpdateModel
720 @HasOne(() => VideoBlacklistModel, {
727 VideoBlacklist: VideoBlacklistModel
729 @HasOne(() => VideoLiveModel, {
736 VideoLive: VideoLiveModel
738 @HasOne(() => VideoImportModel, {
745 VideoImport: VideoImportModel
747 @HasMany(() => VideoCaptionModel, {
754 ['separate' as any]: true
756 VideoCaptions: VideoCaptionModel[]
759 static async sendDelete (instance: MVideoAccountLight, options) {
760 if (instance.isOwned()) {
761 if (!instance.VideoChannel) {
762 instance.VideoChannel = await instance.$get('VideoChannel', {
767 transaction: options.transaction
768 }) as MChannelAccountDefault
771 return sendDeleteVideo(instance, options.transaction)
778 static async removeFiles (instance: VideoModel) {
779 const tasks: Promise<any>[] = []
781 logger.info('Removing files of video %s.', instance.url)
783 if (instance.isOwned()) {
784 if (!Array.isArray(instance.VideoFiles)) {
785 instance.VideoFiles = await instance.$get('VideoFiles')
788 // Remove physical files and torrents
789 instance.VideoFiles.forEach(file => {
790 tasks.push(instance.removeFile(file))
791 tasks.push(instance.removeTorrent(file))
794 // Remove playlists file
795 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
796 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists')
799 for (const p of instance.VideoStreamingPlaylists) {
800 tasks.push(instance.removeStreamingPlaylistFiles(p))
804 // Do not wait video deletion because we could be in a transaction
807 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
814 static stopLiveIfNeeded (instance: VideoModel) {
815 if (!instance.isLive) return
817 return LiveManager.Instance.stopSessionOf(instance.id)
821 static invalidateCache (instance: VideoModel) {
822 ModelCache.Instance.invalidateCache('video', instance.id)
826 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
827 const tasks: Promise<any>[] = []
829 if (!Array.isArray(instance.VideoAbuses)) {
830 instance.VideoAbuses = await instance.$get('VideoAbuses')
832 if (instance.VideoAbuses.length === 0) return undefined
835 logger.info('Saving video abuses details of video %s.', instance.url)
837 const details = instance.toFormattedDetailsJSON()
839 for (const abuse of instance.VideoAbuses) {
840 abuse.deletedVideo = details
841 tasks.push(abuse.save({ transaction: options.transaction }))
846 logger.error('Some errors when saving details of video %s in its abuses before destroy hook.', instance.uuid, { err })
852 static listLocal (): Bluebird<MVideoWithAllFiles[]> {
859 return VideoModel.scope([
860 ScopeNames.WITH_WEBTORRENT_FILES,
861 ScopeNames.WITH_STREAMING_PLAYLISTS,
862 ScopeNames.WITH_THUMBNAILS
866 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
867 function getRawQuery (select: string) {
868 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
869 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
870 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
871 'WHERE "Account"."actorId" = ' + actorId
872 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
873 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
874 'WHERE "VideoShare"."actorId" = ' + actorId
876 return `(${queryVideo}) UNION (${queryVideoShare})`
879 const rawQuery = getRawQuery('"Video"."id"')
880 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
886 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ] as any), // FIXME: sequelize typings
889 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
891 [Op.or]: getPrivaciesForFederation()
895 attributes: [ 'language', 'fileUrl' ],
896 model: VideoCaptionModel.unscoped(),
900 attributes: [ 'id', 'url' ],
901 model: VideoShareModel.unscoped(),
903 // We only want videos shared by this actor
918 attributes: [ 'id', 'url' ],
919 model: ActorModel.unscoped()
924 model: VideoChannelModel.unscoped(),
928 attributes: [ 'name' ],
929 model: AccountModel.unscoped(),
933 attributes: [ 'id', 'url', 'followersUrl' ],
934 model: ActorModel.unscoped(),
940 attributes: [ 'id', 'url', 'followersUrl' ],
941 model: ActorModel.unscoped(),
951 return Bluebird.all([
952 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
953 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
954 ]).then(([ rows, totals ]) => {
955 // totals: totalVideos + totalVideoShares
957 let totalVideoShares = 0
958 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
959 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
961 const total = totalVideos + totalVideoShares
969 static listUserVideosForApi (
976 function buildBaseQuery (): FindOptions {
980 order: getVideoSort(sort),
983 model: VideoChannelModel,
999 baseQuery = Object.assign(baseQuery, {
1002 [Op.iLike]: '%' + search + '%'
1011 const countQuery = buildBaseQuery()
1012 const findQuery = buildBaseQuery()
1014 const findScopes: (string | ScopeOptions)[] = [
1015 ScopeNames.WITH_SCHEDULED_UPDATE,
1016 ScopeNames.WITH_BLACKLISTED,
1017 ScopeNames.WITH_THUMBNAILS
1020 return Promise.all([
1021 VideoModel.count(countQuery),
1022 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
1023 ]).then(([ count, rows ]) => {
1031 static async listForApi (options: {
1036 includeLocalVideos: boolean
1038 categoryOneOf?: number[]
1039 licenceOneOf?: number[]
1040 languageOneOf?: string[]
1041 tagsOneOf?: string[]
1042 tagsAllOf?: string[]
1043 filter?: VideoFilter
1045 videoChannelId?: number
1046 followerActorId?: number
1047 videoPlaylistId?: number
1048 trendingDays?: number
1049 user?: MUserAccountId
1050 historyOfUser?: MUserId
1051 countVideos?: boolean
1053 if (options.filter && options.filter === 'all-local' && !options.user.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1054 throw new Error('Try to filter all-local but no user has not the see all videos right')
1057 const trendingDays = options.sort.endsWith('trending')
1058 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1061 const serverActor = await getServerActor()
1063 // followerActorId === null has a meaning, so just check undefined
1064 const followerActorId = options.followerActorId !== undefined
1065 ? options.followerActorId
1068 const queryOptions = {
1069 start: options.start,
1070 count: options.count,
1073 serverAccountId: serverActor.Account.id,
1075 categoryOneOf: options.categoryOneOf,
1076 licenceOneOf: options.licenceOneOf,
1077 languageOneOf: options.languageOneOf,
1078 tagsOneOf: options.tagsOneOf,
1079 tagsAllOf: options.tagsAllOf,
1080 filter: options.filter,
1081 withFiles: options.withFiles,
1082 accountId: options.accountId,
1083 videoChannelId: options.videoChannelId,
1084 videoPlaylistId: options.videoPlaylistId,
1085 includeLocalVideos: options.includeLocalVideos,
1087 historyOfUser: options.historyOfUser,
1091 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
1094 static async searchAndPopulateAccountAndServer (options: {
1095 includeLocalVideos: boolean
1100 startDate?: string // ISO 8601
1101 endDate?: string // ISO 8601
1102 originallyPublishedStartDate?: string
1103 originallyPublishedEndDate?: string
1105 categoryOneOf?: number[]
1106 licenceOneOf?: number[]
1107 languageOneOf?: string[]
1108 tagsOneOf?: string[]
1109 tagsAllOf?: string[]
1110 durationMin?: number // seconds
1111 durationMax?: number // seconds
1112 user?: MUserAccountId
1113 filter?: VideoFilter
1115 const serverActor = await getServerActor()
1116 const queryOptions = {
1117 followerActorId: serverActor.id,
1118 serverAccountId: serverActor.Account.id,
1119 includeLocalVideos: options.includeLocalVideos,
1121 categoryOneOf: options.categoryOneOf,
1122 licenceOneOf: options.licenceOneOf,
1123 languageOneOf: options.languageOneOf,
1124 tagsOneOf: options.tagsOneOf,
1125 tagsAllOf: options.tagsAllOf,
1127 filter: options.filter,
1128 start: options.start,
1129 count: options.count,
1131 startDate: options.startDate,
1132 endDate: options.endDate,
1133 originallyPublishedStartDate: options.originallyPublishedStartDate,
1134 originallyPublishedEndDate: options.originallyPublishedEndDate,
1136 durationMin: options.durationMin,
1137 durationMax: options.durationMax,
1139 search: options.search
1142 return VideoModel.getAvailableForApi(queryOptions)
1145 static load (id: number | string, t?: Transaction): Bluebird<MVideoThumbnail> {
1146 const where = buildWhereIdOrUUID(id)
1152 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1155 static loadWithBlacklist (id: number | string, t?: Transaction): Bluebird<MVideoThumbnailBlacklist> {
1156 const where = buildWhereIdOrUUID(id)
1162 return VideoModel.scope([
1163 ScopeNames.WITH_THUMBNAILS,
1164 ScopeNames.WITH_BLACKLISTED
1168 static loadImmutableAttributes (id: number | string, t?: Transaction): Bluebird<MVideoImmutable> {
1171 where: buildWhereIdOrUUID(id),
1175 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1178 return ModelCache.Instance.doCache({
1179 cacheType: 'load-video-immutable-id',
1186 static loadWithRights (id: number | string, t?: Transaction): Bluebird<MVideoWithRights> {
1187 const where = buildWhereIdOrUUID(id)
1193 return VideoModel.scope([
1194 ScopeNames.WITH_BLACKLISTED,
1195 ScopeNames.WITH_USER_ID,
1196 ScopeNames.WITH_THUMBNAILS
1200 static loadOnlyId (id: number | string, t?: Transaction): Bluebird<MVideoIdThumbnail> {
1201 const where = buildWhereIdOrUUID(id)
1204 attributes: [ 'id' ],
1209 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1212 static loadWithFiles (id: number | string, t?: Transaction, logging?: boolean): Bluebird<MVideoWithAllFiles> {
1213 const where = buildWhereIdOrUUID(id)
1221 return VideoModel.scope([
1222 ScopeNames.WITH_WEBTORRENT_FILES,
1223 ScopeNames.WITH_STREAMING_PLAYLISTS,
1224 ScopeNames.WITH_THUMBNAILS
1228 static loadByUUID (uuid: string): Bluebird<MVideoThumbnail> {
1235 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options)
1238 static loadByUrl (url: string, transaction?: Transaction): Bluebird<MVideoThumbnail> {
1239 const query: FindOptions = {
1246 return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(query)
1249 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Bluebird<MVideoImmutable> {
1251 const query: FindOptions = {
1258 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1261 return ModelCache.Instance.doCache({
1262 cacheType: 'load-video-immutable-url',
1269 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Bluebird<MVideoAccountLightBlacklistAllFiles> {
1270 const query: FindOptions = {
1277 return VideoModel.scope([
1278 ScopeNames.WITH_ACCOUNT_DETAILS,
1279 ScopeNames.WITH_WEBTORRENT_FILES,
1280 ScopeNames.WITH_STREAMING_PLAYLISTS,
1281 ScopeNames.WITH_THUMBNAILS,
1282 ScopeNames.WITH_BLACKLISTED
1286 static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Bluebird<MVideoFullLight> {
1287 const where = buildWhereIdOrUUID(id)
1290 order: [ [ 'Tags', 'name', 'ASC' ] ] as any,
1295 const scopes: (string | ScopeOptions)[] = [
1296 ScopeNames.WITH_TAGS,
1297 ScopeNames.WITH_BLACKLISTED,
1298 ScopeNames.WITH_ACCOUNT_DETAILS,
1299 ScopeNames.WITH_SCHEDULED_UPDATE,
1300 ScopeNames.WITH_WEBTORRENT_FILES,
1301 ScopeNames.WITH_STREAMING_PLAYLISTS,
1302 ScopeNames.WITH_THUMBNAILS
1306 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1314 static loadForGetAPI (parameters: {
1318 }): Bluebird<MVideoDetails> {
1319 const { id, t, userId } = parameters
1320 const where = buildWhereIdOrUUID(id)
1323 order: [ [ 'Tags', 'name', 'ASC' ] ] as any, // FIXME: sequelize typings
1328 const scopes: (string | ScopeOptions)[] = [
1329 ScopeNames.WITH_TAGS,
1330 ScopeNames.WITH_BLACKLISTED,
1331 ScopeNames.WITH_ACCOUNT_DETAILS,
1332 ScopeNames.WITH_SCHEDULED_UPDATE,
1333 ScopeNames.WITH_THUMBNAILS,
1334 { method: [ ScopeNames.WITH_WEBTORRENT_FILES, true ] },
1335 { method: [ ScopeNames.WITH_STREAMING_PLAYLISTS, true ] }
1339 scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] })
1347 static async getStats () {
1348 const totalLocalVideos = await VideoModel.count({
1354 let totalLocalVideoViews = await VideoModel.sum('views', {
1360 // Sequelize could return null...
1361 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1363 const { total: totalVideos } = await VideoModel.listForApi({
1366 sort: '-publishedAt',
1367 nsfw: buildNSFWFilter(),
1368 includeLocalVideos: true,
1374 totalLocalVideoViews,
1379 static incrementViews (id: number, views: number) {
1380 return VideoModel.increment('views', {
1388 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1389 // Instances only share videos
1390 const query = 'SELECT 1 FROM "videoShare" ' +
1391 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1392 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1396 type: QueryTypes.SELECT as QueryTypes.SELECT,
1397 bind: { followerActorId, videoId },
1401 return VideoModel.sequelize.query(query, options)
1402 .then(results => results.length === 1)
1405 static bulkUpdateSupportField (videoChannel: MChannel, t: Transaction) {
1408 channelId: videoChannel.id
1413 return VideoModel.update({ support: videoChannel.support }, options)
1416 static getAllIdsFromChannel (videoChannel: MChannelId): Bluebird<number[]> {
1418 attributes: [ 'id' ],
1420 channelId: videoChannel.id
1424 return VideoModel.findAll(query)
1425 .then(videos => videos.map(v => v.id))
1428 // threshold corresponds to how many video the field should have to be returned
1429 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1430 const serverActor = await getServerActor()
1431 const followerActorId = serverActor.id
1433 const queryOptions: BuildVideosQueryOptions = {
1434 attributes: [ `"${field}"` ],
1435 group: `GROUP BY "${field}"`,
1436 having: `HAVING COUNT("${field}") >= ${threshold}`,
1440 serverAccountId: serverActor.Account.id,
1442 includeLocalVideos: true
1445 const { query, replacements } = buildListQuery(VideoModel, queryOptions)
1447 return this.sequelize.query<any>(query, { replacements, type: QueryTypes.SELECT })
1448 .then(rows => rows.map(r => r[field]))
1451 static buildTrendingQuery (trendingDays: number) {
1455 model: VideoViewModel,
1459 [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1465 private static async getAvailableForApi (
1466 options: BuildVideosQueryOptions,
1468 ): Promise<ResultList<VideoModel>> {
1469 function getCount () {
1470 if (countVideos !== true) return Promise.resolve(undefined)
1472 const countOptions = Object.assign({}, options, { isCount: true })
1473 const { query: queryCount, replacements: replacementsCount } = buildListQuery(VideoModel, countOptions)
1475 return VideoModel.sequelize.query<any>(queryCount, { replacements: replacementsCount, type: QueryTypes.SELECT })
1476 .then(rows => rows.length !== 0 ? rows[0].total : 0)
1479 function getModels () {
1480 if (options.count === 0) return Promise.resolve([])
1482 const { query, replacements, order } = buildListQuery(VideoModel, options)
1483 const queryModels = wrapForAPIResults(query, replacements, options, order)
1485 return VideoModel.sequelize.query<any>(queryModels, { replacements, type: QueryTypes.SELECT, nest: true })
1486 .then(rows => VideoModel.buildAPIResult(rows))
1489 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1497 private static buildAPIResult (rows: any[]) {
1498 const videosMemo: { [ id: number ]: VideoModel } = {}
1499 const videoStreamingPlaylistMemo: { [ id: number ]: VideoStreamingPlaylistModel } = {}
1501 const thumbnailsDone = new Set<number>()
1502 const historyDone = new Set<number>()
1503 const videoFilesDone = new Set<number>()
1505 const videos: VideoModel[] = []
1507 const avatarKeys = [ 'id', 'filename', 'fileUrl', 'onDisk', 'createdAt', 'updatedAt' ]
1508 const actorKeys = [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ]
1509 const serverKeys = [ 'id', 'host' ]
1510 const videoFileKeys = [ 'id', 'createdAt', 'updatedAt', 'resolution', 'size', 'extname', 'infoHash', 'fps', 'videoId' ]
1511 const videoStreamingPlaylistKeys = [ 'id' ]
1534 'originallyPublishedAt',
1540 function buildActor (rowActor: any) {
1541 const avatarModel = rowActor.Avatar.id !== null
1542 ? new AvatarModel(pick(rowActor.Avatar, avatarKeys))
1545 const serverModel = rowActor.Server.id !== null
1546 ? new ServerModel(pick(rowActor.Server, serverKeys))
1549 const actorModel = new ActorModel(pick(rowActor, actorKeys))
1550 actorModel.Avatar = avatarModel
1551 actorModel.Server = serverModel
1556 for (const row of rows) {
1557 if (!videosMemo[row.id]) {
1559 const channel = row.VideoChannel
1560 const channelModel = new VideoChannelModel(pick(channel, [ 'id', 'name', 'description', 'actorId' ]))
1561 channelModel.Actor = buildActor(channel.Actor)
1563 const account = row.VideoChannel.Account
1564 const accountModel = new AccountModel(pick(account, [ 'id', 'name' ]))
1565 accountModel.Actor = buildActor(account.Actor)
1567 channelModel.Account = accountModel
1569 const videoModel = new VideoModel(pick(row, videoKeys))
1570 videoModel.VideoChannel = channelModel
1572 videoModel.UserVideoHistories = []
1573 videoModel.Thumbnails = []
1574 videoModel.VideoFiles = []
1575 videoModel.VideoStreamingPlaylists = []
1577 videosMemo[row.id] = videoModel
1578 // Don't take object value to have a sorted array
1579 videos.push(videoModel)
1582 const videoModel = videosMemo[row.id]
1584 if (row.userVideoHistory?.id && !historyDone.has(row.userVideoHistory.id)) {
1585 const historyModel = new UserVideoHistoryModel(pick(row.userVideoHistory, [ 'id', 'currentTime' ]))
1586 videoModel.UserVideoHistories.push(historyModel)
1588 historyDone.add(row.userVideoHistory.id)
1591 if (row.Thumbnails?.id && !thumbnailsDone.has(row.Thumbnails.id)) {
1592 const thumbnailModel = new ThumbnailModel(pick(row.Thumbnails, [ 'id', 'type', 'filename' ]))
1593 videoModel.Thumbnails.push(thumbnailModel)
1595 thumbnailsDone.add(row.Thumbnails.id)
1598 if (row.VideoFiles?.id && !videoFilesDone.has(row.VideoFiles.id)) {
1599 const videoFileModel = new VideoFileModel(pick(row.VideoFiles, videoFileKeys))
1600 videoModel.VideoFiles.push(videoFileModel)
1602 videoFilesDone.add(row.VideoFiles.id)
1605 if (row.VideoFiles?.id && !videoFilesDone.has(row.VideoFiles.id)) {
1606 const videoFileModel = new VideoFileModel(pick(row.VideoFiles, videoFileKeys))
1607 videoModel.VideoFiles.push(videoFileModel)
1609 videoFilesDone.add(row.VideoFiles.id)
1612 if (row.VideoStreamingPlaylists?.id && !videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]) {
1613 const streamingPlaylist = new VideoStreamingPlaylistModel(pick(row.VideoStreamingPlaylists, videoStreamingPlaylistKeys))
1614 streamingPlaylist.VideoFiles = []
1616 videoModel.VideoStreamingPlaylists.push(streamingPlaylist)
1618 videoStreamingPlaylistMemo[streamingPlaylist.id] = streamingPlaylist
1621 if (row.VideoStreamingPlaylists?.VideoFiles?.id && !videoFilesDone.has(row.VideoStreamingPlaylists.VideoFiles.id)) {
1622 const streamingPlaylist = videoStreamingPlaylistMemo[row.VideoStreamingPlaylists.id]
1624 const videoFileModel = new VideoFileModel(pick(row.VideoStreamingPlaylists.VideoFiles, videoFileKeys))
1625 streamingPlaylist.VideoFiles.push(videoFileModel)
1627 videoFilesDone.add(row.VideoStreamingPlaylists.VideoFiles.id)
1634 static getCategoryLabel (id: number) {
1635 return VIDEO_CATEGORIES[id] || 'Misc'
1638 static getLicenceLabel (id: number) {
1639 return VIDEO_LICENCES[id] || 'Unknown'
1642 static getLanguageLabel (id: string) {
1643 return VIDEO_LANGUAGES[id] || 'Unknown'
1646 static getPrivacyLabel (id: number) {
1647 return VIDEO_PRIVACIES[id] || 'Unknown'
1650 static getStateLabel (id: number) {
1651 return VIDEO_STATES[id] || 'Unknown'
1655 return !!this.VideoBlacklist
1659 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1662 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1663 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
1664 const file = fun(this.VideoFiles, file => file.resolution)
1666 return Object.assign(file, { Video: this })
1669 // No webtorrent files, try with streaming playlist files
1670 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1671 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1673 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
1674 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1680 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1681 return this.getQualityFileBy(maxBy)
1684 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1685 return this.getQualityFileBy(minBy)
1688 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1689 if (Array.isArray(this.VideoFiles) === false) return undefined
1691 const file = this.VideoFiles.find(f => f.resolution === resolution)
1692 if (!file) return undefined
1694 return Object.assign(file, { Video: this })
1697 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction: Transaction) {
1698 thumbnail.videoId = this.id
1700 const savedThumbnail = await thumbnail.save({ transaction })
1702 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1704 // Already have this thumbnail, skip
1705 if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return
1707 this.Thumbnails.push(savedThumbnail)
1710 generateThumbnailName () {
1711 return this.uuid + '.jpg'
1715 if (Array.isArray(this.Thumbnails) === false) return undefined
1717 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1720 generatePreviewName () {
1721 return this.uuid + '.jpg'
1725 return !!this.getPreview()
1729 if (Array.isArray(this.Thumbnails) === false) return undefined
1731 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1735 return this.remote === false
1738 getWatchStaticPath () {
1739 return '/videos/watch/' + this.uuid
1742 getEmbedStaticPath () {
1743 return '/videos/embed/' + this.uuid
1746 getMiniatureStaticPath () {
1747 const thumbnail = this.getMiniature()
1748 if (!thumbnail) return null
1750 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1753 getPreviewStaticPath () {
1754 const preview = this.getPreview()
1755 if (!preview) return null
1757 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1758 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1761 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1762 return videoModelToFormattedJSON(this, options)
1765 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1766 return videoModelToFormattedDetailsJSON(this)
1769 getFormattedVideoFilesJSON (): VideoFile[] {
1770 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1771 let files: MVideoFileRedundanciesOpt[] = []
1773 if (Array.isArray(this.VideoFiles)) {
1774 files = files.concat(this.VideoFiles)
1777 for (const p of (this.VideoStreamingPlaylists || [])) {
1778 files = files.concat(p.VideoFiles || [])
1781 return videoFilesModelToFormattedJSON(this, baseUrlHttp, baseUrlWs, files)
1784 toActivityPubObject (this: MVideoAP): VideoObject {
1785 return videoModelToActivityPubObject(this)
1788 getTruncatedDescription () {
1789 if (!this.description) return null
1791 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1792 return peertubeTruncate(this.description, { length: maxLength })
1795 getMaxQualityResolution () {
1796 const file = this.getMaxQualityFile()
1797 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1798 const originalFilePath = getVideoFilePath(videoOrPlaylist, file)
1800 return getVideoFileResolution(originalFilePath)
1803 getDescriptionAPIPath () {
1804 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1807 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1808 if (!this.VideoStreamingPlaylists) return undefined
1810 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1811 playlist.Video = this
1816 setHLSPlaylist (playlist: MStreamingPlaylist) {
1817 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1819 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1820 this.VideoStreamingPlaylists = toAdd
1824 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1825 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1829 removeFile (videoFile: MVideoFile, isRedundancy = false) {
1830 const filePath = getVideoFilePath(this, videoFile, isRedundancy)
1831 return remove(filePath)
1832 .catch(err => logger.warn('Cannot delete file %s.', filePath, { err }))
1835 removeTorrent (videoFile: MVideoFile) {
1836 const torrentPath = getTorrentFilePath(this, videoFile)
1837 return remove(torrentPath)
1838 .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
1841 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1842 const directoryPath = getHLSDirectory(this, isRedundancy)
1844 await remove(directoryPath)
1846 if (isRedundancy !== true) {
1847 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1848 streamingPlaylistWithFiles.Video = this
1850 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1851 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1854 // Remove physical files and torrents
1856 streamingPlaylistWithFiles.VideoFiles.map(file => streamingPlaylistWithFiles.removeTorrent(file))
1862 if (this.isOwned()) return false
1864 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1867 hasPrivacyForFederation () {
1868 return isPrivacyForFederation(this.privacy)
1871 isNewVideo (newPrivacy: VideoPrivacy) {
1872 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
1876 this.changed('updatedAt', true)
1882 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
1885 setPrivacy (newPrivacy: VideoPrivacy) {
1886 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
1887 this.publishedAt = new Date()
1890 this.privacy = newPrivacy
1894 return this.privacy === VideoPrivacy.PRIVATE ||
1895 this.privacy === VideoPrivacy.UNLISTED ||
1896 this.privacy === VideoPrivacy.INTERNAL
1899 async publishIfNeededAndSave (t: Transaction) {
1900 if (this.state !== VideoState.PUBLISHED) {
1901 this.state = VideoState.PUBLISHED
1902 this.publishedAt = new Date()
1903 await this.save({ transaction: t })
1912 if (this.isOwned()) {
1914 baseUrlHttp: WEBSERVER.URL,
1915 baseUrlWs: WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT
1920 baseUrlHttp: REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host,
1921 baseUrlWs: REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
1925 getTrackerUrls (baseUrlHttp: string, baseUrlWs: string) {
1926 return [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1929 getTorrentUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1930 return baseUrlHttp + STATIC_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
1933 getTorrentDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1934 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
1937 getVideoFileUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1938 return baseUrlHttp + STATIC_PATHS.WEBSEED + getVideoFilename(this, videoFile)
1941 getVideoFileMetadataUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1942 const path = '/api/v1/videos/'
1944 return this.isOwned()
1945 ? baseUrlHttp + path + this.uuid + '/metadata/' + videoFile.id
1946 : videoFile.metadataUrl
1949 getVideoRedundancyUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1950 return baseUrlHttp + STATIC_PATHS.REDUNDANCY + getVideoFilename(this, videoFile)
1953 getVideoFileDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
1954 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + getVideoFilename(this, videoFile)
1957 getBandwidthBits (videoFile: MVideoFile) {
1958 return Math.ceil((videoFile.size * 8) / this.duration)