1 import * as Bluebird from 'bluebird'
2 import { map, maxBy } from 'lodash'
3 import * as magnetUtil from 'magnet-uri'
4 import * as parseTorrent from 'parse-torrent'
5 import { extname, join } from 'path'
6 import * as Sequelize from 'sequelize'
28 } from 'sequelize-typescript'
29 import { VideoPrivacy, VideoResolution, VideoState } from '../../../shared'
30 import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
31 import { Video, VideoDetails, VideoFile } from '../../../shared/models/videos'
32 import { VideoFilter } from '../../../shared/models/videos/video-query.type'
41 } from '../../helpers/core-utils'
42 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
43 import { isBooleanValid } from '../../helpers/custom-validators/misc'
46 isVideoDescriptionValid,
54 } from '../../helpers/custom-validators/videos'
55 import { generateImageFromVideoFile, getVideoFileFPS, getVideoFileResolution, transcode } from '../../helpers/ffmpeg-utils'
56 import { logger } from '../../helpers/logger'
57 import { getServerActor } from '../../helpers/utils'
64 STATIC_DOWNLOAD_PATHS,
73 } from '../../initializers'
75 getVideoCommentsActivityPubUrl,
76 getVideoDislikesActivityPubUrl,
77 getVideoLikesActivityPubUrl,
78 getVideoSharesActivityPubUrl
79 } from '../../lib/activitypub'
80 import { sendDeleteVideo } from '../../lib/activitypub/send'
81 import { AccountModel } from '../account/account'
82 import { AccountVideoRateModel } from '../account/account-video-rate'
83 import { ActorModel } from '../activitypub/actor'
84 import { AvatarModel } from '../avatar/avatar'
85 import { ServerModel } from '../server/server'
86 import { buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
87 import { TagModel } from './tag'
88 import { VideoAbuseModel } from './video-abuse'
89 import { VideoChannelModel } from './video-channel'
90 import { VideoCommentModel } from './video-comment'
91 import { VideoFileModel } from './video-file'
92 import { VideoShareModel } from './video-share'
93 import { VideoTagModel } from './video-tag'
94 import { ScheduleVideoUpdateModel } from './schedule-video-update'
95 import { VideoCaptionModel } from './video-caption'
97 // FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation
98 const indexes: Sequelize.DefineIndexesOptions[] = [
99 buildTrigramSearchIndex('video_name_trigram', 'name'),
101 { fields: [ 'createdAt' ] },
102 { fields: [ 'publishedAt' ] },
103 { fields: [ 'duration' ] },
104 { fields: [ 'category' ] },
105 { fields: [ 'licence' ] },
106 { fields: [ 'nsfw' ] },
107 { fields: [ 'language' ] },
108 { fields: [ 'waitTranscoding' ] },
109 { fields: [ 'state' ] },
110 { fields: [ 'remote' ] },
111 { fields: [ 'views' ] },
112 { fields: [ 'likes' ] },
113 { fields: [ 'channelId' ] },
124 export enum ScopeNames {
125 AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
126 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
127 WITH_TAGS = 'WITH_TAGS',
128 WITH_FILES = 'WITH_FILES',
129 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE'
132 type AvailableForListOptions = {
134 filter?: VideoFilter,
135 categoryOneOf?: number[],
137 licenceOneOf?: number[],
138 languageOneOf?: string[],
139 tagsOneOf?: string[],
140 tagsAllOf?: string[],
143 videoChannelId?: number
147 [ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => {
148 const accountInclude = {
149 attributes: [ 'id', 'name' ],
150 model: AccountModel.unscoped(),
155 attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
156 model: ActorModel.unscoped(),
158 where: VideoModel.buildActorWhereWithFilter(options.filter),
161 attributes: [ 'host' ],
162 model: ServerModel.unscoped(),
166 model: AvatarModel.unscoped(),
174 const videoChannelInclude = {
175 attributes: [ 'name', 'description', 'id' ],
176 model: VideoChannelModel.unscoped(),
181 attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
182 model: ActorModel.unscoped(),
186 attributes: [ 'host' ],
187 model: ServerModel.unscoped(),
191 model: AvatarModel.unscoped(),
200 // Force actorId to be a number to avoid SQL injections
201 const actorIdNumber = parseInt(options.actorId.toString(), 10)
203 // FIXME: It would be more efficient to use a CTE so we join AFTER the filters, but sequelize does not support it...
204 const query: IFindOptions<VideoModel> = {
207 [Sequelize.Op.notIn]: Sequelize.literal(
208 '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")'
210 [ Sequelize.Op.in ]: Sequelize.literal(
212 'SELECT "videoShare"."videoId" AS "id" FROM "videoShare" ' +
213 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
214 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
216 'SELECT "video"."id" AS "id" FROM "video" ' +
217 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
218 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
219 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
220 'WHERE "actor"."serverId" IS NULL ' +
222 'SELECT "video"."id" AS "id" FROM "video" ' +
223 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
224 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
225 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
226 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "actor"."id" ' +
227 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
231 // Always list public videos
232 privacy: VideoPrivacy.PUBLIC,
233 // Always list published videos, or videos that are being transcoded but on which we don't want to wait for transcoding
234 [ Sequelize.Op.or ]: [
236 state: VideoState.PUBLISHED
239 [ Sequelize.Op.and ]: {
240 state: VideoState.TO_TRANSCODE,
241 waitTranscoding: false
246 include: [ videoChannelInclude ]
249 if (options.withFiles === true) {
251 model: VideoFileModel.unscoped(),
256 // FIXME: issues with sequelize count when making a join on n:m relation, so we just make a IN()
257 if (options.tagsAllOf || options.tagsOneOf) {
258 const createTagsIn = (tags: string[]) => {
259 return tags.map(t => VideoModel.sequelize.escape(t))
263 if (options.tagsOneOf) {
264 query.where['id'][Sequelize.Op.in] = Sequelize.literal(
266 'SELECT "videoId" FROM "videoTag" ' +
267 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
268 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsOneOf) + ')' +
273 if (options.tagsAllOf) {
274 query.where['id'][Sequelize.Op.in] = Sequelize.literal(
276 'SELECT "videoId" FROM "videoTag" ' +
277 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
278 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsAllOf) + ')' +
279 'GROUP BY "videoTag"."videoId" HAVING COUNT(*) = ' + options.tagsAllOf.length +
285 if (options.nsfw === true || options.nsfw === false) {
286 query.where['nsfw'] = options.nsfw
289 if (options.categoryOneOf) {
290 query.where['category'] = {
291 [Sequelize.Op.or]: options.categoryOneOf
295 if (options.licenceOneOf) {
296 query.where['licence'] = {
297 [Sequelize.Op.or]: options.licenceOneOf
301 if (options.languageOneOf) {
302 query.where['language'] = {
303 [Sequelize.Op.or]: options.languageOneOf
307 if (options.accountId) {
308 accountInclude.where = {
309 id: options.accountId
313 if (options.videoChannelId) {
314 videoChannelInclude.where = {
315 id: options.videoChannelId
321 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
324 model: () => VideoChannelModel.unscoped(),
329 exclude: [ 'privateKey', 'publicKey' ]
331 model: () => ActorModel.unscoped(),
335 attributes: [ 'host' ],
336 model: () => ServerModel.unscoped(),
340 model: () => AvatarModel.unscoped(),
346 model: () => AccountModel.unscoped(),
350 model: () => ActorModel.unscoped(),
352 exclude: [ 'privateKey', 'publicKey' ]
357 attributes: [ 'host' ],
358 model: () => ServerModel.unscoped(),
362 model: () => AvatarModel.unscoped(),
373 [ScopeNames.WITH_TAGS]: {
374 include: [ () => TagModel ]
376 [ScopeNames.WITH_FILES]: {
379 model: () => VideoFileModel.unscoped(),
384 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
387 model: () => ScheduleVideoUpdateModel.unscoped(),
397 export class VideoModel extends Model<VideoModel> {
400 @Default(DataType.UUIDV4)
402 @Column(DataType.UUID)
406 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
412 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category'))
418 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence'))
424 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language'))
425 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
429 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
434 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
440 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description'))
441 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
446 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support'))
447 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
451 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
481 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
482 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
487 commentsEnabled: boolean
491 waitTranscoding: boolean
495 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
506 @Default(Sequelize.NOW)
510 @ForeignKey(() => VideoChannelModel)
514 @BelongsTo(() => VideoChannelModel, {
520 VideoChannel: VideoChannelModel
522 @BelongsToMany(() => TagModel, {
523 foreignKey: 'videoId',
524 through: () => VideoTagModel,
529 @HasMany(() => VideoAbuseModel, {
536 VideoAbuses: VideoAbuseModel[]
538 @HasMany(() => VideoFileModel, {
545 VideoFiles: VideoFileModel[]
547 @HasMany(() => VideoShareModel, {
554 VideoShares: VideoShareModel[]
556 @HasMany(() => AccountVideoRateModel, {
563 AccountVideoRates: AccountVideoRateModel[]
565 @HasMany(() => VideoCommentModel, {
573 VideoComments: VideoCommentModel[]
575 @HasOne(() => ScheduleVideoUpdateModel, {
582 ScheduleVideoUpdate: ScheduleVideoUpdateModel
584 @HasMany(() => VideoCaptionModel, {
591 ['separate' as any]: true
593 VideoCaptions: VideoCaptionModel[]
596 static async sendDelete (instance: VideoModel, options) {
597 if (instance.isOwned()) {
598 if (!instance.VideoChannel) {
599 instance.VideoChannel = await instance.$get('VideoChannel', {
603 include: [ ActorModel ]
606 transaction: options.transaction
607 }) as VideoChannelModel
610 return sendDeleteVideo(instance, options.transaction)
617 static async removeFiles (instance: VideoModel) {
618 const tasks: Promise<any>[] = []
620 logger.info('Removing files of video %s.', instance.url)
622 tasks.push(instance.removeThumbnail())
624 if (instance.isOwned()) {
625 if (!Array.isArray(instance.VideoFiles)) {
626 instance.VideoFiles = await instance.$get('VideoFiles') as VideoFileModel[]
629 tasks.push(instance.removePreview())
631 // Remove physical files and torrents
632 instance.VideoFiles.forEach(file => {
633 tasks.push(instance.removeFile(file))
634 tasks.push(instance.removeTorrent(file))
638 // Do not wait video deletion because we could be in a transaction
641 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
648 return VideoModel.scope(ScopeNames.WITH_FILES).findAll()
651 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
652 function getRawQuery (select: string) {
653 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
654 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
655 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
656 'WHERE "Account"."actorId" = ' + actorId
657 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
658 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
659 'WHERE "VideoShare"."actorId" = ' + actorId
661 return `(${queryVideo}) UNION (${queryVideoShare})`
664 const rawQuery = getRawQuery('"Video"."id"')
665 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
671 order: getSort('createdAt', [ 'Tags', 'name', 'ASC' ]),
674 [Sequelize.Op.in]: Sequelize.literal('(' + rawQuery + ')')
677 { privacy: VideoPrivacy.PUBLIC },
678 { privacy: VideoPrivacy.UNLISTED }
683 attributes: [ 'language' ],
684 model: VideoCaptionModel.unscoped(),
688 attributes: [ 'id', 'url' ],
689 model: VideoShareModel.unscoped(),
691 // We only want videos shared by this actor
693 [Sequelize.Op.and]: [
696 [Sequelize.Op.not]: null
706 attributes: [ 'id', 'url' ],
707 model: ActorModel.unscoped()
712 model: VideoChannelModel.unscoped(),
716 attributes: [ 'name' ],
717 model: AccountModel.unscoped(),
721 attributes: [ 'id', 'url', 'followersUrl' ],
722 model: ActorModel.unscoped(),
728 attributes: [ 'id', 'url', 'followersUrl' ],
729 model: ActorModel.unscoped(),
739 return Bluebird.all([
740 // FIXME: typing issue
741 VideoModel.findAll(query as any),
742 VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT })
743 ]).then(([ rows, totals ]) => {
744 // totals: totalVideos + totalVideoShares
746 let totalVideoShares = 0
747 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
748 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
750 const total = totalVideos + totalVideoShares
758 static listUserVideosForApi (accountId: number, start: number, count: number, sort: string, hideNSFW: boolean, withFiles = false) {
759 const query: IFindOptions<VideoModel> = {
762 order: getSort(sort),
765 model: VideoChannelModel,
778 model: ScheduleVideoUpdateModel,
784 if (withFiles === true) {
786 model: VideoFileModel.unscoped(),
791 if (hideNSFW === true) {
797 return VideoModel.findAndCountAll(query).then(({ rows, count }) => {
805 static async listForApi (options: {
811 categoryOneOf?: number[],
812 licenceOneOf?: number[],
813 languageOneOf?: string[],
814 tagsOneOf?: string[],
815 tagsAllOf?: string[],
816 filter?: VideoFilter,
818 videoChannelId?: number
821 offset: options.start,
822 limit: options.count,
823 order: getSort(options.sort)
826 const serverActor = await getServerActor()
829 ScopeNames.AVAILABLE_FOR_LIST, {
830 actorId: serverActor.id,
832 categoryOneOf: options.categoryOneOf,
833 licenceOneOf: options.licenceOneOf,
834 languageOneOf: options.languageOneOf,
835 tagsOneOf: options.tagsOneOf,
836 tagsAllOf: options.tagsAllOf,
837 filter: options.filter,
838 withFiles: options.withFiles,
839 accountId: options.accountId,
840 videoChannelId: options.videoChannelId
841 } as AvailableForListOptions
845 return VideoModel.scope(scopes)
846 .findAndCountAll(query)
847 .then(({ rows, count }) => {
855 static async searchAndPopulateAccountAndServer (options: {
860 startDate?: string // ISO 8601
861 endDate?: string // ISO 8601
863 categoryOneOf?: number[]
864 licenceOneOf?: number[]
865 languageOneOf?: string[]
868 durationMin?: number // seconds
869 durationMax?: number // seconds
873 if (options.startDate || options.endDate) {
874 const publishedAtRange = { }
876 if (options.startDate) publishedAtRange[Sequelize.Op.gte] = options.startDate
877 if (options.endDate) publishedAtRange[Sequelize.Op.lte] = options.endDate
879 whereAnd.push({ publishedAt: publishedAtRange })
882 if (options.durationMin || options.durationMax) {
883 const durationRange = { }
885 if (options.durationMin) durationRange[Sequelize.Op.gte] = options.durationMin
886 if (options.durationMax) durationRange[Sequelize.Op.lte] = options.durationMax
888 whereAnd.push({ duration: durationRange })
891 const attributesInclude = []
892 const escapedSearch = VideoModel.sequelize.escape(options.search)
893 const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
894 if (options.search) {
898 [ Sequelize.Op.in ]: Sequelize.literal(
900 'SELECT "video"."id" FROM "video" WHERE ' +
901 'lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
902 'lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' +
904 'SELECT "video"."id" FROM "video" LEFT JOIN "videoTag" ON "videoTag"."videoId" = "video"."id" ' +
905 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
906 'WHERE "tag"."name" = ' + escapedSearch +
913 attributesInclude.push(createSimilarityAttribute('VideoModel.name', options.search))
916 // Cannot search on similarity if we don't have a search
917 if (!options.search) {
918 attributesInclude.push(
919 Sequelize.literal('0 as similarity')
923 const query: IFindOptions<VideoModel> = {
925 include: attributesInclude
927 offset: options.start,
928 limit: options.count,
929 order: getSort(options.sort),
931 [ Sequelize.Op.and ]: whereAnd
935 const serverActor = await getServerActor()
938 ScopeNames.AVAILABLE_FOR_LIST, {
939 actorId: serverActor.id,
941 categoryOneOf: options.categoryOneOf,
942 licenceOneOf: options.licenceOneOf,
943 languageOneOf: options.languageOneOf,
944 tagsOneOf: options.tagsOneOf,
945 tagsAllOf: options.tagsAllOf
946 } as AvailableForListOptions
950 return VideoModel.scope(scopes)
951 .findAndCountAll(query)
952 .then(({ rows, count }) => {
960 static load (id: number) {
961 return VideoModel.findById(id)
964 static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
965 const query: IFindOptions<VideoModel> = {
971 if (t !== undefined) query.transaction = t
973 return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
976 static loadByUUIDOrURLAndPopulateAccount (uuid: string, url: string, t?: Sequelize.Transaction) {
977 const query: IFindOptions<VideoModel> = {
986 if (t !== undefined) query.transaction = t
988 return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
991 static loadAndPopulateAccountAndServerAndTags (id: number) {
993 order: [ [ 'Tags', 'name', 'ASC' ] ]
997 .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE ])
998 .findById(id, options)
1001 static loadByUUID (uuid: string) {
1009 .scope([ ScopeNames.WITH_FILES ])
1013 static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string, t?: Sequelize.Transaction) {
1015 order: [ [ 'Tags', 'name', 'ASC' ] ],
1023 .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE ])
1027 static async getStats () {
1028 const totalLocalVideos = await VideoModel.count({
1033 const totalVideos = await VideoModel.count()
1035 let totalLocalVideoViews = await VideoModel.sum('views', {
1040 // Sequelize could return null...
1041 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1045 totalLocalVideoViews,
1050 private static buildActorWhereWithFilter (filter?: VideoFilter) {
1051 if (filter && filter === 'local') {
1060 private static getCategoryLabel (id: number) {
1061 return VIDEO_CATEGORIES[id] || 'Misc'
1064 private static getLicenceLabel (id: number) {
1065 return VIDEO_LICENCES[id] || 'Unknown'
1068 private static getLanguageLabel (id: string) {
1069 return VIDEO_LANGUAGES[id] || 'Unknown'
1072 private static getPrivacyLabel (id: number) {
1073 return VIDEO_PRIVACIES[id] || 'Unknown'
1076 private static getStateLabel (id: number) {
1077 return VIDEO_STATES[id] || 'Unknown'
1080 getOriginalFile () {
1081 if (Array.isArray(this.VideoFiles) === false) return undefined
1083 // The original file is the file that have the higher resolution
1084 return maxBy(this.VideoFiles, file => file.resolution)
1087 getVideoFilename (videoFile: VideoFileModel) {
1088 return this.uuid + '-' + videoFile.resolution + videoFile.extname
1091 getThumbnailName () {
1092 // We always have a copy of the thumbnail
1093 const extension = '.jpg'
1094 return this.uuid + extension
1098 const extension = '.jpg'
1099 return this.uuid + extension
1102 getTorrentFileName (videoFile: VideoFileModel) {
1103 const extension = '.torrent'
1104 return this.uuid + '-' + videoFile.resolution + extension
1108 return this.remote === false
1111 createPreview (videoFile: VideoFileModel) {
1112 return generateImageFromVideoFile(
1113 this.getVideoFilePath(videoFile),
1114 CONFIG.STORAGE.PREVIEWS_DIR,
1115 this.getPreviewName(),
1120 createThumbnail (videoFile: VideoFileModel) {
1121 return generateImageFromVideoFile(
1122 this.getVideoFilePath(videoFile),
1123 CONFIG.STORAGE.THUMBNAILS_DIR,
1124 this.getThumbnailName(),
1129 getTorrentFilePath (videoFile: VideoFileModel) {
1130 return join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1133 getVideoFilePath (videoFile: VideoFileModel) {
1134 return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1137 async createTorrentAndSetInfoHash (videoFile: VideoFileModel) {
1139 // Keep the extname, it's used by the client to stream the file inside a web browser
1140 name: `${this.name} ${videoFile.resolution}p${videoFile.extname}`,
1141 createdBy: 'PeerTube',
1143 [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ],
1144 [ CONFIG.WEBSERVER.URL + '/tracker/announce' ]
1147 CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1151 const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options)
1153 const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1154 logger.info('Creating torrent %s.', filePath)
1156 await writeFilePromise(filePath, torrent)
1158 const parsedTorrent = parseTorrent(torrent)
1159 videoFile.infoHash = parsedTorrent.infoHash
1162 getEmbedStaticPath () {
1163 return '/videos/embed/' + this.uuid
1166 getThumbnailStaticPath () {
1167 return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName())
1170 getPreviewStaticPath () {
1171 return join(STATIC_PATHS.PREVIEWS, this.getPreviewName())
1174 toFormattedJSON (options?: {
1175 additionalAttributes: {
1177 waitTranscoding?: boolean,
1178 scheduledUpdate?: boolean
1181 const formattedAccount = this.VideoChannel.Account.toFormattedJSON()
1182 const formattedVideoChannel = this.VideoChannel.toFormattedJSON()
1184 const videoObject: Video = {
1190 label: VideoModel.getCategoryLabel(this.category)
1194 label: VideoModel.getLicenceLabel(this.licence)
1198 label: VideoModel.getLanguageLabel(this.language)
1202 label: VideoModel.getPrivacyLabel(this.privacy)
1205 description: this.getTruncatedDescription(),
1206 isLocal: this.isOwned(),
1207 duration: this.duration,
1210 dislikes: this.dislikes,
1211 thumbnailPath: this.getThumbnailStaticPath(),
1212 previewPath: this.getPreviewStaticPath(),
1213 embedPath: this.getEmbedStaticPath(),
1214 createdAt: this.createdAt,
1215 updatedAt: this.updatedAt,
1216 publishedAt: this.publishedAt,
1218 id: formattedAccount.id,
1219 uuid: formattedAccount.uuid,
1220 name: formattedAccount.name,
1221 displayName: formattedAccount.displayName,
1222 url: formattedAccount.url,
1223 host: formattedAccount.host,
1224 avatar: formattedAccount.avatar
1227 id: formattedVideoChannel.id,
1228 uuid: formattedVideoChannel.uuid,
1229 name: formattedVideoChannel.name,
1230 displayName: formattedVideoChannel.displayName,
1231 url: formattedVideoChannel.url,
1232 host: formattedVideoChannel.host,
1233 avatar: formattedVideoChannel.avatar
1238 if (options.additionalAttributes.state === true) {
1239 videoObject.state = {
1241 label: VideoModel.getStateLabel(this.state)
1245 if (options.additionalAttributes.waitTranscoding === true) {
1246 videoObject.waitTranscoding = this.waitTranscoding
1249 if (options.additionalAttributes.scheduledUpdate === true && this.ScheduleVideoUpdate) {
1250 videoObject.scheduledUpdate = {
1251 updateAt: this.ScheduleVideoUpdate.updateAt,
1252 privacy: this.ScheduleVideoUpdate.privacy || undefined
1260 toFormattedDetailsJSON (): VideoDetails {
1261 const formattedJson = this.toFormattedJSON({
1262 additionalAttributes: {
1263 scheduledUpdate: true
1267 const detailsJson = {
1268 support: this.support,
1269 descriptionPath: this.getDescriptionPath(),
1270 channel: this.VideoChannel.toFormattedJSON(),
1271 account: this.VideoChannel.Account.toFormattedJSON(),
1272 tags: map(this.Tags, 'name'),
1273 commentsEnabled: this.commentsEnabled,
1274 waitTranscoding: this.waitTranscoding,
1277 label: VideoModel.getStateLabel(this.state)
1282 // Format and sort video files
1283 detailsJson.files = this.getFormattedVideoFilesJSON()
1285 return Object.assign(formattedJson, detailsJson)
1288 getFormattedVideoFilesJSON (): VideoFile[] {
1289 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1291 return this.VideoFiles
1293 let resolutionLabel = videoFile.resolution + 'p'
1297 id: videoFile.resolution,
1298 label: resolutionLabel
1300 magnetUri: this.generateMagnetUri(videoFile, baseUrlHttp, baseUrlWs),
1301 size: videoFile.size,
1303 torrentUrl: this.getTorrentUrl(videoFile, baseUrlHttp),
1304 torrentDownloadUrl: this.getTorrentDownloadUrl(videoFile, baseUrlHttp),
1305 fileUrl: this.getVideoFileUrl(videoFile, baseUrlHttp),
1306 fileDownloadUrl: this.getVideoFileDownloadUrl(videoFile, baseUrlHttp)
1310 if (a.resolution.id < b.resolution.id) return 1
1311 if (a.resolution.id === b.resolution.id) return 0
1316 toActivityPubObject (): VideoTorrentObject {
1317 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1318 if (!this.Tags) this.Tags = []
1320 const tag = this.Tags.map(t => ({
1321 type: 'Hashtag' as 'Hashtag',
1326 if (this.language) {
1328 identifier: this.language,
1329 name: VideoModel.getLanguageLabel(this.language)
1334 if (this.category) {
1336 identifier: this.category + '',
1337 name: VideoModel.getCategoryLabel(this.category)
1344 identifier: this.licence + '',
1345 name: VideoModel.getLicenceLabel(this.licence)
1350 for (const file of this.VideoFiles) {
1353 mimeType: VIDEO_EXT_MIMETYPE[file.extname],
1354 href: this.getVideoFileUrl(file, baseUrlHttp),
1355 width: file.resolution,
1361 mimeType: 'application/x-bittorrent',
1362 href: this.getTorrentUrl(file, baseUrlHttp),
1363 width: file.resolution
1368 mimeType: 'application/x-bittorrent;x-scheme-handler/magnet',
1369 href: this.generateMagnetUri(file, baseUrlHttp, baseUrlWs),
1370 width: file.resolution
1374 // Add video url too
1377 mimeType: 'text/html',
1378 href: CONFIG.WEBSERVER.URL + '/videos/watch/' + this.uuid
1381 const subtitleLanguage = []
1382 for (const caption of this.VideoCaptions) {
1383 subtitleLanguage.push({
1384 identifier: caption.language,
1385 name: VideoCaptionModel.getLanguageLabel(caption.language)
1390 type: 'Video' as 'Video',
1393 duration: this.getActivityStreamDuration(),
1400 sensitive: this.nsfw,
1401 waitTranscoding: this.waitTranscoding,
1403 commentsEnabled: this.commentsEnabled,
1404 published: this.publishedAt.toISOString(),
1405 updated: this.updatedAt.toISOString(),
1406 mediaType: 'text/markdown',
1407 content: this.getTruncatedDescription(),
1408 support: this.support,
1412 url: this.getThumbnailUrl(baseUrlHttp),
1413 mediaType: 'image/jpeg',
1414 width: THUMBNAILS_SIZE.width,
1415 height: THUMBNAILS_SIZE.height
1418 likes: getVideoLikesActivityPubUrl(this),
1419 dislikes: getVideoDislikesActivityPubUrl(this),
1420 shares: getVideoSharesActivityPubUrl(this),
1421 comments: getVideoCommentsActivityPubUrl(this),
1425 id: this.VideoChannel.Account.Actor.url
1429 id: this.VideoChannel.Actor.url
1435 getTruncatedDescription () {
1436 if (!this.description) return null
1438 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1439 return peertubeTruncate(this.description, maxLength)
1442 async optimizeOriginalVideofile () {
1443 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1444 const newExtname = '.mp4'
1445 const inputVideoFile = this.getOriginalFile()
1446 const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile))
1447 const videoTranscodedPath = join(videosDirectory, this.id + '-transcoded' + newExtname)
1449 const transcodeOptions = {
1450 inputPath: videoInputPath,
1451 outputPath: videoTranscodedPath
1454 // Could be very long!
1455 await transcode(transcodeOptions)
1458 await unlinkPromise(videoInputPath)
1460 // Important to do this before getVideoFilename() to take in account the new file extension
1461 inputVideoFile.set('extname', newExtname)
1463 const videoOutputPath = this.getVideoFilePath(inputVideoFile)
1464 await renamePromise(videoTranscodedPath, videoOutputPath)
1465 const stats = await statPromise(videoOutputPath)
1466 const fps = await getVideoFileFPS(videoOutputPath)
1468 inputVideoFile.set('size', stats.size)
1469 inputVideoFile.set('fps', fps)
1471 await this.createTorrentAndSetInfoHash(inputVideoFile)
1472 await inputVideoFile.save()
1475 // Auto destruction...
1476 this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
1482 async transcodeOriginalVideofile (resolution: VideoResolution, isPortraitMode: boolean) {
1483 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1484 const extname = '.mp4'
1486 // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
1487 const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile()))
1489 const newVideoFile = new VideoFileModel({
1495 const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile))
1497 const transcodeOptions = {
1498 inputPath: videoInputPath,
1499 outputPath: videoOutputPath,
1504 await transcode(transcodeOptions)
1506 const stats = await statPromise(videoOutputPath)
1507 const fps = await getVideoFileFPS(videoOutputPath)
1509 newVideoFile.set('size', stats.size)
1510 newVideoFile.set('fps', fps)
1512 await this.createTorrentAndSetInfoHash(newVideoFile)
1514 await newVideoFile.save()
1516 this.VideoFiles.push(newVideoFile)
1519 async importVideoFile (inputFilePath: string) {
1520 const { videoFileResolution } = await getVideoFileResolution(inputFilePath)
1521 const { size } = await statPromise(inputFilePath)
1522 const fps = await getVideoFileFPS(inputFilePath)
1524 let updatedVideoFile = new VideoFileModel({
1525 resolution: videoFileResolution,
1526 extname: extname(inputFilePath),
1532 const currentVideoFile = this.VideoFiles.find(videoFile => videoFile.resolution === updatedVideoFile.resolution)
1534 if (currentVideoFile) {
1535 // Remove old file and old torrent
1536 await this.removeFile(currentVideoFile)
1537 await this.removeTorrent(currentVideoFile)
1538 // Remove the old video file from the array
1539 this.VideoFiles = this.VideoFiles.filter(f => f !== currentVideoFile)
1541 // Update the database
1542 currentVideoFile.set('extname', updatedVideoFile.extname)
1543 currentVideoFile.set('size', updatedVideoFile.size)
1544 currentVideoFile.set('fps', updatedVideoFile.fps)
1546 updatedVideoFile = currentVideoFile
1549 const outputPath = this.getVideoFilePath(updatedVideoFile)
1550 await copyFilePromise(inputFilePath, outputPath)
1552 await this.createTorrentAndSetInfoHash(updatedVideoFile)
1554 await updatedVideoFile.save()
1556 this.VideoFiles.push(updatedVideoFile)
1559 getOriginalFileResolution () {
1560 const originalFilePath = this.getVideoFilePath(this.getOriginalFile())
1562 return getVideoFileResolution(originalFilePath)
1565 getDescriptionPath () {
1566 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1569 removeThumbnail () {
1570 const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName())
1571 return unlinkPromise(thumbnailPath)
1575 // Same name than video thumbnail
1576 return unlinkPromise(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName())
1579 removeFile (videoFile: VideoFileModel) {
1580 const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1581 return unlinkPromise(filePath)
1584 removeTorrent (videoFile: VideoFileModel) {
1585 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1586 return unlinkPromise(torrentPath)
1589 getActivityStreamDuration () {
1590 // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
1591 return 'PT' + this.duration + 'S'
1594 private getBaseUrls () {
1598 if (this.isOwned()) {
1599 baseUrlHttp = CONFIG.WEBSERVER.URL
1600 baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
1602 baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host
1603 baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
1606 return { baseUrlHttp, baseUrlWs }
1609 private getThumbnailUrl (baseUrlHttp: string) {
1610 return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName()
1613 private getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1614 return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1617 private getTorrentDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1618 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1621 private getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1622 return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1625 private getVideoFileDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1626 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + this.getVideoFilename(videoFile)
1629 private generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) {
1630 const xs = this.getTorrentUrl(videoFile, baseUrlHttp)
1631 const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1632 const urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ]
1634 const magnetHash = {
1638 infoHash: videoFile.infoHash,
1642 return magnetUtil.encode(magnetHash)