1 import * as Bluebird from 'bluebird'
2 import { maxBy } from 'lodash'
3 import * as magnetUtil from 'magnet-uri'
4 import * as parseTorrent from 'parse-torrent'
5 import { join } from 'path'
6 import * as Sequelize from 'sequelize'
29 } from 'sequelize-typescript'
30 import { VideoPrivacy, VideoState } from '../../../shared'
31 import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
32 import { Video, VideoDetails, VideoFile } from '../../../shared/models/videos'
33 import { VideoFilter } from '../../../shared/models/videos/video-query.type'
34 import { createTorrentPromise, peertubeTruncate } from '../../helpers/core-utils'
35 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
36 import { isArray, isBooleanValid } from '../../helpers/custom-validators/misc'
39 isVideoDescriptionValid,
47 } from '../../helpers/custom-validators/videos'
48 import { generateImageFromVideoFile, getVideoFileResolution } from '../../helpers/ffmpeg-utils'
49 import { logger } from '../../helpers/logger'
50 import { getServerActor } from '../../helpers/utils'
58 STATIC_DOWNLOAD_PATHS,
66 } from '../../initializers'
67 import { sendDeleteVideo } from '../../lib/activitypub/send'
68 import { AccountModel } from '../account/account'
69 import { AccountVideoRateModel } from '../account/account-video-rate'
70 import { ActorModel } from '../activitypub/actor'
71 import { AvatarModel } from '../avatar/avatar'
72 import { ServerModel } from '../server/server'
73 import { buildTrigramSearchIndex, createSimilarityAttribute, getVideoSort, throwIfNotValid } from '../utils'
74 import { TagModel } from './tag'
75 import { VideoAbuseModel } from './video-abuse'
76 import { VideoChannelModel } from './video-channel'
77 import { VideoCommentModel } from './video-comment'
78 import { VideoFileModel } from './video-file'
79 import { VideoShareModel } from './video-share'
80 import { VideoTagModel } from './video-tag'
81 import { ScheduleVideoUpdateModel } from './schedule-video-update'
82 import { VideoCaptionModel } from './video-caption'
83 import { VideoBlacklistModel } from './video-blacklist'
84 import { remove, writeFile } from 'fs-extra'
85 import { VideoViewModel } from './video-views'
86 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
88 videoFilesModelToFormattedJSON,
89 VideoFormattingJSONOptions,
90 videoModelToActivityPubObject,
91 videoModelToFormattedDetailsJSON,
92 videoModelToFormattedJSON
93 } from './video-format-utils'
95 // FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation
96 const indexes: Sequelize.DefineIndexesOptions[] = [
97 buildTrigramSearchIndex('video_name_trigram', 'name'),
99 { fields: [ 'createdAt' ] },
100 { fields: [ 'publishedAt' ] },
101 { fields: [ 'duration' ] },
102 { fields: [ 'category' ] },
103 { fields: [ 'licence' ] },
104 { fields: [ 'nsfw' ] },
105 { fields: [ 'language' ] },
106 { fields: [ 'waitTranscoding' ] },
107 { fields: [ 'state' ] },
108 { fields: [ 'remote' ] },
109 { fields: [ 'views' ] },
110 { fields: [ 'likes' ] },
111 { fields: [ 'channelId' ] },
122 export enum ScopeNames {
123 AVAILABLE_FOR_LIST_IDS = 'AVAILABLE_FOR_LIST_IDS',
125 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
126 WITH_TAGS = 'WITH_TAGS',
127 WITH_FILES = 'WITH_FILES',
128 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
129 WITH_BLACKLISTED = 'WITH_BLACKLISTED'
132 type ForAPIOptions = {
137 type AvailableForListIDsOptions = {
139 includeLocalVideos: boolean
141 categoryOneOf?: number[]
143 licenceOneOf?: number[]
144 languageOneOf?: string[]
149 videoChannelId?: number
150 trendingDays?: number
154 [ ScopeNames.FOR_API ]: (options: ForAPIOptions) => {
155 const accountInclude = {
156 attributes: [ 'id', 'name' ],
157 model: AccountModel.unscoped(),
161 attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
162 model: ActorModel.unscoped(),
166 attributes: [ 'host' ],
167 model: ServerModel.unscoped(),
171 model: AvatarModel.unscoped(),
179 const videoChannelInclude = {
180 attributes: [ 'name', 'description', 'id' ],
181 model: VideoChannelModel.unscoped(),
185 attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
186 model: ActorModel.unscoped(),
190 attributes: [ 'host' ],
191 model: ServerModel.unscoped(),
195 model: AvatarModel.unscoped(),
204 const query: IFindOptions<VideoModel> = {
207 [ Sequelize.Op.any ]: options.ids
210 include: [ videoChannelInclude ]
213 if (options.withFiles === true) {
215 model: VideoFileModel.unscoped(),
222 [ ScopeNames.AVAILABLE_FOR_LIST_IDS ]: (options: AvailableForListIDsOptions) => {
223 const query: IFindOptions<VideoModel> = {
225 attributes: [ 'id' ],
228 [ Sequelize.Op.and ]: [
230 [ Sequelize.Op.notIn ]: Sequelize.literal(
231 '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")'
236 // Always list public videos
237 privacy: VideoPrivacy.PUBLIC,
238 // Always list published videos, or videos that are being transcoded but on which we don't want to wait for transcoding
239 [ Sequelize.Op.or ]: [
241 state: VideoState.PUBLISHED
244 [ Sequelize.Op.and ]: {
245 state: VideoState.TO_TRANSCODE,
246 waitTranscoding: false
254 if (options.filter || options.accountId || options.videoChannelId) {
255 const videoChannelInclude: IIncludeOptions = {
257 model: VideoChannelModel.unscoped(),
261 if (options.videoChannelId) {
262 videoChannelInclude.where = {
263 id: options.videoChannelId
267 if (options.filter || options.accountId) {
268 const accountInclude: IIncludeOptions = {
270 model: AccountModel.unscoped(),
274 if (options.filter) {
275 accountInclude.include = [
278 model: ActorModel.unscoped(),
280 where: VideoModel.buildActorWhereWithFilter(options.filter)
285 if (options.accountId) {
286 accountInclude.where = { id: options.accountId }
289 videoChannelInclude.include = [ accountInclude ]
292 query.include.push(videoChannelInclude)
295 if (options.actorId) {
296 let localVideosReq = ''
297 if (options.includeLocalVideos === true) {
298 localVideosReq = ' UNION ALL ' +
299 'SELECT "video"."id" AS "id" FROM "video" ' +
300 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
301 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
302 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
303 'WHERE "actor"."serverId" IS NULL'
306 // Force actorId to be a number to avoid SQL injections
307 const actorIdNumber = parseInt(options.actorId.toString(), 10)
308 query.where[ 'id' ][ Sequelize.Op.and ].push({
309 [ Sequelize.Op.in ]: Sequelize.literal(
311 'SELECT "videoShare"."videoId" AS "id" FROM "videoShare" ' +
312 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
313 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
315 'SELECT "video"."id" AS "id" FROM "video" ' +
316 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
317 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
318 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
319 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "actor"."id" ' +
320 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
327 if (options.withFiles === true) {
328 query.where[ 'id' ][ Sequelize.Op.and ].push({
329 [ Sequelize.Op.in ]: Sequelize.literal(
330 '(SELECT "videoId" FROM "videoFile")'
335 // FIXME: issues with sequelize count when making a join on n:m relation, so we just make a IN()
336 if (options.tagsAllOf || options.tagsOneOf) {
337 const createTagsIn = (tags: string[]) => {
338 return tags.map(t => VideoModel.sequelize.escape(t))
342 if (options.tagsOneOf) {
343 query.where[ 'id' ][ Sequelize.Op.and ].push({
344 [ Sequelize.Op.in ]: Sequelize.literal(
346 'SELECT "videoId" FROM "videoTag" ' +
347 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
348 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsOneOf) + ')' +
354 if (options.tagsAllOf) {
355 query.where[ 'id' ][ Sequelize.Op.and ].push({
356 [ Sequelize.Op.in ]: Sequelize.literal(
358 'SELECT "videoId" FROM "videoTag" ' +
359 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
360 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsAllOf) + ')' +
361 'GROUP BY "videoTag"."videoId" HAVING COUNT(*) = ' + options.tagsAllOf.length +
368 if (options.nsfw === true || options.nsfw === false) {
369 query.where[ 'nsfw' ] = options.nsfw
372 if (options.categoryOneOf) {
373 query.where[ 'category' ] = {
374 [ Sequelize.Op.or ]: options.categoryOneOf
378 if (options.licenceOneOf) {
379 query.where[ 'licence' ] = {
380 [ Sequelize.Op.or ]: options.licenceOneOf
384 if (options.languageOneOf) {
385 query.where[ 'language' ] = {
386 [ Sequelize.Op.or ]: options.languageOneOf
390 if (options.trendingDays) {
391 query.include.push(VideoModel.buildTrendingQuery(options.trendingDays))
393 query.subQuery = false
398 [ ScopeNames.WITH_ACCOUNT_DETAILS ]: {
401 model: () => VideoChannelModel.unscoped(),
406 exclude: [ 'privateKey', 'publicKey' ]
408 model: () => ActorModel.unscoped(),
412 attributes: [ 'host' ],
413 model: () => ServerModel.unscoped(),
417 model: () => AvatarModel.unscoped(),
423 model: () => AccountModel.unscoped(),
427 model: () => ActorModel.unscoped(),
429 exclude: [ 'privateKey', 'publicKey' ]
434 attributes: [ 'host' ],
435 model: () => ServerModel.unscoped(),
439 model: () => AvatarModel.unscoped(),
450 [ ScopeNames.WITH_TAGS ]: {
451 include: [ () => TagModel ]
453 [ ScopeNames.WITH_BLACKLISTED ]: {
456 attributes: [ 'id', 'reason' ],
457 model: () => VideoBlacklistModel,
462 [ ScopeNames.WITH_FILES ]: {
465 model: () => VideoFileModel.unscoped(),
469 model: () => VideoRedundancyModel.unscoped(),
476 [ ScopeNames.WITH_SCHEDULED_UPDATE ]: {
479 model: () => ScheduleVideoUpdateModel.unscoped(),
489 export class VideoModel extends Model<VideoModel> {
492 @Default(DataType.UUIDV4)
494 @Column(DataType.UUID)
498 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
504 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category'))
510 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence'))
516 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language'))
517 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
521 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
526 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
532 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description'))
533 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
538 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support'))
539 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
543 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
573 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
574 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
579 commentsEnabled: boolean
583 waitTranscoding: boolean
587 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
598 @Default(Sequelize.NOW)
602 @ForeignKey(() => VideoChannelModel)
606 @BelongsTo(() => VideoChannelModel, {
612 VideoChannel: VideoChannelModel
614 @BelongsToMany(() => TagModel, {
615 foreignKey: 'videoId',
616 through: () => VideoTagModel,
621 @HasMany(() => VideoAbuseModel, {
628 VideoAbuses: VideoAbuseModel[]
630 @HasMany(() => VideoFileModel, {
638 VideoFiles: VideoFileModel[]
640 @HasMany(() => VideoShareModel, {
647 VideoShares: VideoShareModel[]
649 @HasMany(() => AccountVideoRateModel, {
656 AccountVideoRates: AccountVideoRateModel[]
658 @HasMany(() => VideoCommentModel, {
666 VideoComments: VideoCommentModel[]
668 @HasMany(() => VideoViewModel, {
676 VideoViews: VideoViewModel[]
678 @HasOne(() => ScheduleVideoUpdateModel, {
685 ScheduleVideoUpdate: ScheduleVideoUpdateModel
687 @HasOne(() => VideoBlacklistModel, {
694 VideoBlacklist: VideoBlacklistModel
696 @HasMany(() => VideoCaptionModel, {
703 [ 'separate' as any ]: true
705 VideoCaptions: VideoCaptionModel[]
708 static async sendDelete (instance: VideoModel, options) {
709 if (instance.isOwned()) {
710 if (!instance.VideoChannel) {
711 instance.VideoChannel = await instance.$get('VideoChannel', {
715 include: [ ActorModel ]
718 transaction: options.transaction
719 }) as VideoChannelModel
722 return sendDeleteVideo(instance, options.transaction)
729 static async removeFiles (instance: VideoModel) {
730 const tasks: Promise<any>[] = []
732 logger.info('Removing files of video %s.', instance.url)
734 tasks.push(instance.removeThumbnail())
736 if (instance.isOwned()) {
737 if (!Array.isArray(instance.VideoFiles)) {
738 instance.VideoFiles = await instance.$get('VideoFiles') as VideoFileModel[]
741 tasks.push(instance.removePreview())
743 // Remove physical files and torrents
744 instance.VideoFiles.forEach(file => {
745 tasks.push(instance.removeFile(file))
746 tasks.push(instance.removeTorrent(file))
750 // Do not wait video deletion because we could be in a transaction
753 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
760 return VideoModel.scope(ScopeNames.WITH_FILES).findAll()
763 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
764 function getRawQuery (select: string) {
765 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
766 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
767 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
768 'WHERE "Account"."actorId" = ' + actorId
769 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
770 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
771 'WHERE "VideoShare"."actorId" = ' + actorId
773 return `(${queryVideo}) UNION (${queryVideoShare})`
776 const rawQuery = getRawQuery('"Video"."id"')
777 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
783 order: getVideoSort('createdAt', [ 'Tags', 'name', 'ASC' ]),
786 [ Sequelize.Op.in ]: Sequelize.literal('(' + rawQuery + ')')
788 [ Sequelize.Op.or ]: [
789 { privacy: VideoPrivacy.PUBLIC },
790 { privacy: VideoPrivacy.UNLISTED }
795 attributes: [ 'language' ],
796 model: VideoCaptionModel.unscoped(),
800 attributes: [ 'id', 'url' ],
801 model: VideoShareModel.unscoped(),
803 // We only want videos shared by this actor
805 [ Sequelize.Op.and ]: [
808 [ Sequelize.Op.not ]: null
818 attributes: [ 'id', 'url' ],
819 model: ActorModel.unscoped()
824 model: VideoChannelModel.unscoped(),
828 attributes: [ 'name' ],
829 model: AccountModel.unscoped(),
833 attributes: [ 'id', 'url', 'followersUrl' ],
834 model: ActorModel.unscoped(),
840 attributes: [ 'id', 'url', 'followersUrl' ],
841 model: ActorModel.unscoped(),
851 return Bluebird.all([
852 // FIXME: typing issue
853 VideoModel.findAll(query as any),
854 VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT })
855 ]).then(([ rows, totals ]) => {
856 // totals: totalVideos + totalVideoShares
858 let totalVideoShares = 0
859 if (totals[ 0 ]) totalVideos = parseInt(totals[ 0 ].total, 10)
860 if (totals[ 1 ]) totalVideoShares = parseInt(totals[ 1 ].total, 10)
862 const total = totalVideos + totalVideoShares
870 static listUserVideosForApi (accountId: number, start: number, count: number, sort: string, withFiles = false) {
871 const query: IFindOptions<VideoModel> = {
874 order: getVideoSort(sort),
877 model: VideoChannelModel,
890 model: ScheduleVideoUpdateModel,
894 model: VideoBlacklistModel,
900 if (withFiles === true) {
902 model: VideoFileModel.unscoped(),
907 return VideoModel.findAndCountAll(query).then(({ rows, count }) => {
915 static async listForApi (options: {
920 includeLocalVideos: boolean,
922 categoryOneOf?: number[],
923 licenceOneOf?: number[],
924 languageOneOf?: string[],
925 tagsOneOf?: string[],
926 tagsAllOf?: string[],
927 filter?: VideoFilter,
929 videoChannelId?: number,
931 trendingDays?: number
932 }, countVideos = true) {
933 const query: IFindOptions<VideoModel> = {
934 offset: options.start,
935 limit: options.count,
936 order: getVideoSort(options.sort)
939 let trendingDays: number
940 if (options.sort.endsWith('trending')) {
941 trendingDays = CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
943 query.group = 'VideoModel.id'
946 // actorId === null has a meaning, so just check undefined
947 const actorId = options.actorId !== undefined ? options.actorId : (await getServerActor()).id
949 const queryOptions = {
952 categoryOneOf: options.categoryOneOf,
953 licenceOneOf: options.licenceOneOf,
954 languageOneOf: options.languageOneOf,
955 tagsOneOf: options.tagsOneOf,
956 tagsAllOf: options.tagsAllOf,
957 filter: options.filter,
958 withFiles: options.withFiles,
959 accountId: options.accountId,
960 videoChannelId: options.videoChannelId,
961 includeLocalVideos: options.includeLocalVideos,
965 return VideoModel.getAvailableForApi(query, queryOptions, countVideos)
968 static async searchAndPopulateAccountAndServer (options: {
969 includeLocalVideos: boolean
974 startDate?: string // ISO 8601
975 endDate?: string // ISO 8601
977 categoryOneOf?: number[]
978 licenceOneOf?: number[]
979 languageOneOf?: string[]
982 durationMin?: number // seconds
983 durationMax?: number // seconds
987 if (options.startDate || options.endDate) {
988 const publishedAtRange = {}
990 if (options.startDate) publishedAtRange[ Sequelize.Op.gte ] = options.startDate
991 if (options.endDate) publishedAtRange[ Sequelize.Op.lte ] = options.endDate
993 whereAnd.push({ publishedAt: publishedAtRange })
996 if (options.durationMin || options.durationMax) {
997 const durationRange = {}
999 if (options.durationMin) durationRange[ Sequelize.Op.gte ] = options.durationMin
1000 if (options.durationMax) durationRange[ Sequelize.Op.lte ] = options.durationMax
1002 whereAnd.push({ duration: durationRange })
1005 const attributesInclude = []
1006 const escapedSearch = VideoModel.sequelize.escape(options.search)
1007 const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
1008 if (options.search) {
1012 [ Sequelize.Op.in ]: Sequelize.literal(
1014 'SELECT "video"."id" FROM "video" ' +
1016 'lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
1017 'lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' +
1019 'SELECT "video"."id" FROM "video" LEFT JOIN "videoTag" ON "videoTag"."videoId" = "video"."id" ' +
1020 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
1021 'WHERE "tag"."name" = ' + escapedSearch +
1028 attributesInclude.push(createSimilarityAttribute('VideoModel.name', options.search))
1031 // Cannot search on similarity if we don't have a search
1032 if (!options.search) {
1033 attributesInclude.push(
1034 Sequelize.literal('0 as similarity')
1038 const query: IFindOptions<VideoModel> = {
1040 include: attributesInclude
1042 offset: options.start,
1043 limit: options.count,
1044 order: getVideoSort(options.sort),
1046 [ Sequelize.Op.and ]: whereAnd
1050 const serverActor = await getServerActor()
1051 const queryOptions = {
1052 actorId: serverActor.id,
1053 includeLocalVideos: options.includeLocalVideos,
1055 categoryOneOf: options.categoryOneOf,
1056 licenceOneOf: options.licenceOneOf,
1057 languageOneOf: options.languageOneOf,
1058 tagsOneOf: options.tagsOneOf,
1059 tagsAllOf: options.tagsAllOf
1062 return VideoModel.getAvailableForApi(query, queryOptions)
1065 static load (id: number, t?: Sequelize.Transaction) {
1066 return VideoModel.findById(id, { transaction: t })
1069 static loadWithFile (id: number, t?: Sequelize.Transaction, logging?: boolean) {
1070 return VideoModel.scope(ScopeNames.WITH_FILES)
1071 .findById(id, { transaction: t, logging })
1074 static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
1075 const query: IFindOptions<VideoModel> = {
1081 if (t !== undefined) query.transaction = t
1083 return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
1086 static loadAndPopulateAccountAndServerAndTags (id: number) {
1088 order: [ [ 'Tags', 'name', 'ASC' ] ]
1093 ScopeNames.WITH_TAGS,
1094 ScopeNames.WITH_BLACKLISTED,
1095 ScopeNames.WITH_FILES,
1096 ScopeNames.WITH_ACCOUNT_DETAILS,
1097 ScopeNames.WITH_SCHEDULED_UPDATE
1099 .findById(id, options)
1102 static loadByUUID (uuid: string) {
1110 .scope([ ScopeNames.WITH_FILES ])
1114 static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string, t?: Sequelize.Transaction) {
1116 order: [ [ 'Tags', 'name', 'ASC' ] ],
1125 ScopeNames.WITH_TAGS,
1126 ScopeNames.WITH_BLACKLISTED,
1127 ScopeNames.WITH_FILES,
1128 ScopeNames.WITH_ACCOUNT_DETAILS,
1129 ScopeNames.WITH_SCHEDULED_UPDATE
1134 static async getStats () {
1135 const totalLocalVideos = await VideoModel.count({
1140 const totalVideos = await VideoModel.count()
1142 let totalLocalVideoViews = await VideoModel.sum('views', {
1147 // Sequelize could return null...
1148 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1152 totalLocalVideoViews,
1157 static incrementViews (id: number, views: number) {
1158 return VideoModel.increment('views', {
1166 // threshold corresponds to how many video the field should have to be returned
1167 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1168 const actorId = (await getServerActor()).id
1170 const scopeOptions = {
1172 includeLocalVideos: true
1175 const query: IFindOptions<VideoModel> = {
1176 attributes: [ field ],
1179 having: Sequelize.where(Sequelize.fn('COUNT', Sequelize.col(field)), {
1180 [ Sequelize.Op.gte ]: threshold
1181 }) as any, // FIXME: typings
1182 order: [ this.sequelize.random() ]
1185 return VideoModel.scope({ method: [ ScopeNames.AVAILABLE_FOR_LIST_IDS, scopeOptions ] })
1187 .then(rows => rows.map(r => r[ field ]))
1190 static buildTrendingQuery (trendingDays: number) {
1194 model: VideoViewModel,
1198 [ Sequelize.Op.gte ]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1204 private static buildActorWhereWithFilter (filter?: VideoFilter) {
1205 if (filter && filter === 'local') {
1214 private static async getAvailableForApi (query: IFindOptions<VideoModel>, options: AvailableForListIDsOptions, countVideos = true) {
1217 ScopeNames.AVAILABLE_FOR_LIST_IDS, options
1221 // Remove trending sort on count, because it uses a group by
1222 const countOptions = Object.assign({}, options, { trendingDays: undefined })
1223 const countQuery = Object.assign({}, query, { attributes: undefined, group: undefined })
1224 const countScope = {
1226 ScopeNames.AVAILABLE_FOR_LIST_IDS, countOptions
1230 const [ count, rowsId ] = await Promise.all([
1231 countVideos ? VideoModel.scope(countScope).count(countQuery) : Promise.resolve(undefined),
1232 VideoModel.scope(idsScope).findAll(query)
1234 const ids = rowsId.map(r => r.id)
1236 if (ids.length === 0) return { data: [], total: count }
1239 method: [ ScopeNames.FOR_API, { ids, withFiles: options.withFiles } as ForAPIOptions ]
1242 const secondQuery = {
1245 attributes: query.attributes,
1246 order: [ // Keep original order
1248 ids.map(id => `"VideoModel".id = ${id} DESC`).join(', ')
1252 const rows = await VideoModel.scope(apiScope).findAll(secondQuery)
1260 static getCategoryLabel (id: number) {
1261 return VIDEO_CATEGORIES[ id ] || 'Misc'
1264 static getLicenceLabel (id: number) {
1265 return VIDEO_LICENCES[ id ] || 'Unknown'
1268 static getLanguageLabel (id: string) {
1269 return VIDEO_LANGUAGES[ id ] || 'Unknown'
1272 static getPrivacyLabel (id: number) {
1273 return VIDEO_PRIVACIES[ id ] || 'Unknown'
1276 static getStateLabel (id: number) {
1277 return VIDEO_STATES[ id ] || 'Unknown'
1280 getOriginalFile () {
1281 if (Array.isArray(this.VideoFiles) === false) return undefined
1283 // The original file is the file that have the higher resolution
1284 return maxBy(this.VideoFiles, file => file.resolution)
1287 getVideoFilename (videoFile: VideoFileModel) {
1288 return this.uuid + '-' + videoFile.resolution + videoFile.extname
1291 getThumbnailName () {
1292 // We always have a copy of the thumbnail
1293 const extension = '.jpg'
1294 return this.uuid + extension
1298 const extension = '.jpg'
1299 return this.uuid + extension
1302 getTorrentFileName (videoFile: VideoFileModel) {
1303 const extension = '.torrent'
1304 return this.uuid + '-' + videoFile.resolution + extension
1308 return this.remote === false
1311 createPreview (videoFile: VideoFileModel) {
1312 return generateImageFromVideoFile(
1313 this.getVideoFilePath(videoFile),
1314 CONFIG.STORAGE.PREVIEWS_DIR,
1315 this.getPreviewName(),
1320 createThumbnail (videoFile: VideoFileModel) {
1321 return generateImageFromVideoFile(
1322 this.getVideoFilePath(videoFile),
1323 CONFIG.STORAGE.THUMBNAILS_DIR,
1324 this.getThumbnailName(),
1329 getTorrentFilePath (videoFile: VideoFileModel) {
1330 return join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1333 getVideoFilePath (videoFile: VideoFileModel) {
1334 return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1337 async createTorrentAndSetInfoHash (videoFile: VideoFileModel) {
1339 // Keep the extname, it's used by the client to stream the file inside a web browser
1340 name: `${this.name} ${videoFile.resolution}p${videoFile.extname}`,
1341 createdBy: 'PeerTube',
1343 [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ],
1344 [ CONFIG.WEBSERVER.URL + '/tracker/announce' ]
1346 urlList: [ CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) ]
1349 const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options)
1351 const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1352 logger.info('Creating torrent %s.', filePath)
1354 await writeFile(filePath, torrent)
1356 const parsedTorrent = parseTorrent(torrent)
1357 videoFile.infoHash = parsedTorrent.infoHash
1360 getEmbedStaticPath () {
1361 return '/videos/embed/' + this.uuid
1364 getThumbnailStaticPath () {
1365 return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName())
1368 getPreviewStaticPath () {
1369 return join(STATIC_PATHS.PREVIEWS, this.getPreviewName())
1372 toFormattedJSON (options?: VideoFormattingJSONOptions): Video {
1373 return videoModelToFormattedJSON(this, options)
1376 toFormattedDetailsJSON (): VideoDetails {
1377 return videoModelToFormattedDetailsJSON(this)
1380 getFormattedVideoFilesJSON (): VideoFile[] {
1381 return videoFilesModelToFormattedJSON(this, this.VideoFiles)
1384 toActivityPubObject (): VideoTorrentObject {
1385 return videoModelToActivityPubObject(this)
1388 getTruncatedDescription () {
1389 if (!this.description) return null
1391 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1392 return peertubeTruncate(this.description, maxLength)
1395 getOriginalFileResolution () {
1396 const originalFilePath = this.getVideoFilePath(this.getOriginalFile())
1398 return getVideoFileResolution(originalFilePath)
1401 getDescriptionPath () {
1402 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1405 removeThumbnail () {
1406 const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName())
1407 return remove(thumbnailPath)
1408 .catch(err => logger.warn('Cannot delete thumbnail %s.', thumbnailPath, { err }))
1412 const previewPath = join(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName())
1413 return remove(previewPath)
1414 .catch(err => logger.warn('Cannot delete preview %s.', previewPath, { err }))
1417 removeFile (videoFile: VideoFileModel) {
1418 const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1419 return remove(filePath)
1420 .catch(err => logger.warn('Cannot delete file %s.', filePath, { err }))
1423 removeTorrent (videoFile: VideoFileModel) {
1424 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1425 return remove(torrentPath)
1426 .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
1430 if (this.isOwned()) return false
1432 const now = Date.now()
1433 const createdAtTime = this.createdAt.getTime()
1434 const updatedAtTime = this.updatedAt.getTime()
1436 return (now - createdAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL &&
1437 (now - updatedAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL
1444 if (this.isOwned()) {
1445 baseUrlHttp = CONFIG.WEBSERVER.URL
1446 baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
1448 baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host
1449 baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
1452 return { baseUrlHttp, baseUrlWs }
1455 generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) {
1456 const xs = this.getTorrentUrl(videoFile, baseUrlHttp)
1457 const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1458 let urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ]
1460 const redundancies = videoFile.RedundancyVideos
1461 if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl))
1463 const magnetHash = {
1467 infoHash: videoFile.infoHash,
1471 return magnetUtil.encode(magnetHash)
1474 getThumbnailUrl (baseUrlHttp: string) {
1475 return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName()
1478 getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1479 return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1482 getTorrentDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1483 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1486 getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1487 return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1490 getVideoFileDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1491 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + this.getVideoFilename(videoFile)