X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo.ts;h=60023bc8c2a93c252506cc8f78dd9f77b95c95a8;hb=62689b942b71cd1dd0d050c6ed05f884a0b325c2;hp=7dfea8ac955de50bf3e2f523157ad7572f31530c;hpb=556ddc319242aafef51bae9301423ecf8701a3af;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video.ts b/server/models/video/video.ts index 7dfea8ac9..6271db1b3 100644 --- a/server/models/video/video.ts +++ b/server/models/video/video.ts @@ -1,895 +1,1694 @@ -import * as safeBuffer from 'safe-buffer' -const Buffer = safeBuffer.Buffer -import * as ffmpeg from 'fluent-ffmpeg' +import * as Bluebird from 'bluebird' +import { map, maxBy } from 'lodash' import * as magnetUtil from 'magnet-uri' -import { map } from 'lodash' import * as parseTorrent from 'parse-torrent' -import { join } from 'path' +import { extname, join } from 'path' import * as Sequelize from 'sequelize' -import * as Promise from 'bluebird' - -import { TagInstance } from './tag-interface' import { - logger, - isVideoNameValid, + AllowNull, + BeforeDestroy, + BelongsTo, + BelongsToMany, + Column, + CreatedAt, + DataType, + Default, + ForeignKey, + HasMany, + HasOne, + IFindOptions, + Is, + IsInt, + IsUUID, + Min, + Model, + Scopes, + Table, + UpdatedAt +} from 'sequelize-typescript' +import { VideoPrivacy, VideoResolution, VideoState } from '../../../shared' +import { VideoTorrentObject } from '../../../shared/models/activitypub/objects' +import { Video, VideoDetails, VideoFile } from '../../../shared/models/videos' +import { VideoFilter } from '../../../shared/models/videos/video-query.type' +import { createTorrentPromise, peertubeTruncate } from '../../helpers/core-utils' +import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc' +import { isBooleanValid } from '../../helpers/custom-validators/misc' +import { isVideoCategoryValid, - isVideoLicenceValid, - isVideoLanguageValid, - isVideoNSFWValid, isVideoDescriptionValid, isVideoDurationValid, - readFileBufferPromise, - unlinkPromise, - renamePromise, - writeFilePromise, - createTorrentPromise -} from '../../helpers' + isVideoLanguageValid, + isVideoLicenceValid, + isVideoNameValid, + isVideoPrivacyValid, + isVideoStateValid, + isVideoSupportValid +} from '../../helpers/custom-validators/videos' +import { generateImageFromVideoFile, getVideoFileFPS, getVideoFileResolution, transcode } from '../../helpers/ffmpeg-utils' +import { logger } from '../../helpers/logger' +import { getServerActor } from '../../helpers/utils' import { + ACTIVITY_PUB, + API_VERSION, CONFIG, + CONSTRAINTS_FIELDS, + PREVIEWS_SIZE, REMOTE_SCHEME, + STATIC_DOWNLOAD_PATHS, STATIC_PATHS, + THUMBNAILS_SIZE, VIDEO_CATEGORIES, - VIDEO_LICENCES, + VIDEO_EXT_MIMETYPE, VIDEO_LANGUAGES, - THUMBNAILS_SIZE, - VIDEO_FILE_RESOLUTIONS + VIDEO_LICENCES, + VIDEO_PRIVACIES, + VIDEO_STATES } from '../../initializers' -import { removeVideoToFriends } from '../../lib' -import { VideoFileInstance } from './video-file-interface' - -import { addMethodsToModel, getSort } from '../utils' import { - VideoInstance, - VideoAttributes, - - VideoMethods -} from './video-interface' - -let Video: Sequelize.Model -let generateMagnetUri: VideoMethods.GenerateMagnetUri -let getVideoFilename: VideoMethods.GetVideoFilename -let getThumbnailName: VideoMethods.GetThumbnailName -let getPreviewName: VideoMethods.GetPreviewName -let getTorrentFileName: VideoMethods.GetTorrentFileName -let isOwned: VideoMethods.IsOwned -let toFormattedJSON: VideoMethods.ToFormattedJSON -let toAddRemoteJSON: VideoMethods.ToAddRemoteJSON -let toUpdateRemoteJSON: VideoMethods.ToUpdateRemoteJSON -let transcodeVideofile: VideoMethods.TranscodeVideofile -let createPreview: VideoMethods.CreatePreview -let createThumbnail: VideoMethods.CreateThumbnail -let getVideoFilePath: VideoMethods.GetVideoFilePath -let createTorrentAndSetInfoHash: VideoMethods.CreateTorrentAndSetInfoHash - -let generateThumbnailFromData: VideoMethods.GenerateThumbnailFromData -let getDurationFromFile: VideoMethods.GetDurationFromFile -let list: VideoMethods.List -let listForApi: VideoMethods.ListForApi -let loadByHostAndUUID: VideoMethods.LoadByHostAndUUID -let listOwnedAndPopulateAuthorAndTags: VideoMethods.ListOwnedAndPopulateAuthorAndTags -let listOwnedByAuthor: VideoMethods.ListOwnedByAuthor -let load: VideoMethods.Load -let loadByUUID: VideoMethods.LoadByUUID -let loadAndPopulateAuthor: VideoMethods.LoadAndPopulateAuthor -let loadAndPopulateAuthorAndPodAndTags: VideoMethods.LoadAndPopulateAuthorAndPodAndTags -let loadByUUIDAndPopulateAuthorAndPodAndTags: VideoMethods.LoadByUUIDAndPopulateAuthorAndPodAndTags -let searchAndPopulateAuthorAndPodAndTags: VideoMethods.SearchAndPopulateAuthorAndPodAndTags -let removeThumbnail: VideoMethods.RemoveThumbnail -let removePreview: VideoMethods.RemovePreview -let removeFile: VideoMethods.RemoveFile -let removeTorrent: VideoMethods.RemoveTorrent - -export default function (sequelize: Sequelize.Sequelize, DataTypes: Sequelize.DataTypes) { - Video = sequelize.define('Video', - { - uuid: { - type: DataTypes.UUID, - defaultValue: DataTypes.UUIDV4, - allowNull: false, - validate: { - isUUID: 4 - } - }, - name: { - type: DataTypes.STRING, - allowNull: false, - validate: { - nameValid: value => { - const res = isVideoNameValid(value) - if (res === false) throw new Error('Video name is not valid.') - } - } - }, - category: { - type: DataTypes.INTEGER, - allowNull: false, - validate: { - categoryValid: value => { - const res = isVideoCategoryValid(value) - if (res === false) throw new Error('Video category is not valid.') - } - } - }, - licence: { - type: DataTypes.INTEGER, - allowNull: false, - defaultValue: null, - validate: { - licenceValid: value => { - const res = isVideoLicenceValid(value) - if (res === false) throw new Error('Video licence is not valid.') - } - } - }, - language: { - type: DataTypes.INTEGER, - allowNull: true, - validate: { - languageValid: value => { - const res = isVideoLanguageValid(value) - if (res === false) throw new Error('Video language is not valid.') - } - } - }, - nsfw: { - type: DataTypes.BOOLEAN, - allowNull: false, - validate: { - nsfwValid: value => { - const res = isVideoNSFWValid(value) - if (res === false) throw new Error('Video nsfw attribute is not valid.') - } + getVideoCommentsActivityPubUrl, + getVideoDislikesActivityPubUrl, + getVideoLikesActivityPubUrl, + getVideoSharesActivityPubUrl +} from '../../lib/activitypub' +import { sendDeleteVideo } from '../../lib/activitypub/send' +import { AccountModel } from '../account/account' +import { AccountVideoRateModel } from '../account/account-video-rate' +import { ActorModel } from '../activitypub/actor' +import { AvatarModel } from '../avatar/avatar' +import { ServerModel } from '../server/server' +import { buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils' +import { TagModel } from './tag' +import { VideoAbuseModel } from './video-abuse' +import { VideoChannelModel } from './video-channel' +import { VideoCommentModel } from './video-comment' +import { VideoFileModel } from './video-file' +import { VideoShareModel } from './video-share' +import { VideoTagModel } from './video-tag' +import { ScheduleVideoUpdateModel } from './schedule-video-update' +import { VideoCaptionModel } from './video-caption' +import { VideoBlacklistModel } from './video-blacklist' +import { copy, remove, rename, stat, writeFile } from 'fs-extra' + +// FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation +const indexes: Sequelize.DefineIndexesOptions[] = [ + buildTrigramSearchIndex('video_name_trigram', 'name'), + + { fields: [ 'createdAt' ] }, + { fields: [ 'publishedAt' ] }, + { fields: [ 'duration' ] }, + { fields: [ 'category' ] }, + { fields: [ 'licence' ] }, + { fields: [ 'nsfw' ] }, + { fields: [ 'language' ] }, + { fields: [ 'waitTranscoding' ] }, + { fields: [ 'state' ] }, + { fields: [ 'remote' ] }, + { fields: [ 'views' ] }, + { fields: [ 'likes' ] }, + { fields: [ 'channelId' ] }, + { + fields: [ 'uuid' ], + unique: true + }, + { + fields: [ 'url'], + unique: true + } +] + +export enum ScopeNames { + AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST', + WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS', + WITH_TAGS = 'WITH_TAGS', + WITH_FILES = 'WITH_FILES', + WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE', + WITH_BLACKLISTED = 'WITH_BLACKLISTED' +} + +type AvailableForListOptions = { + actorId: number, + includeLocalVideos: boolean, + filter?: VideoFilter, + categoryOneOf?: number[], + nsfw?: boolean, + licenceOneOf?: number[], + languageOneOf?: string[], + tagsOneOf?: string[], + tagsAllOf?: string[], + withFiles?: boolean, + accountId?: number, + videoChannelId?: number +} + +@Scopes({ + [ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => { + const accountInclude = { + attributes: [ 'id', 'name' ], + model: AccountModel.unscoped(), + required: true, + where: {}, + include: [ + { + attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ], + model: ActorModel.unscoped(), + required: true, + where: VideoModel.buildActorWhereWithFilter(options.filter), + include: [ + { + attributes: [ 'host' ], + model: ServerModel.unscoped(), + required: false + }, + { + model: AvatarModel.unscoped(), + required: false + } + ] } - }, - description: { - type: DataTypes.STRING, - allowNull: false, - validate: { - descriptionValid: value => { - const res = isVideoDescriptionValid(value) - if (res === false) throw new Error('Video description is not valid.') + ] + } + + const videoChannelInclude = { + attributes: [ 'name', 'description', 'id' ], + model: VideoChannelModel.unscoped(), + required: true, + where: {}, + include: [ + { + attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ], + model: ActorModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'host' ], + model: ServerModel.unscoped(), + required: false + }, + { + model: AvatarModel.unscoped(), + required: false + } + ] + }, + accountInclude + ] + } + + // FIXME: It would be more efficient to use a CTE so we join AFTER the filters, but sequelize does not support it... + const query: IFindOptions = { + where: { + id: { + [Sequelize.Op.notIn]: Sequelize.literal( + '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")' + ) + }, + // Always list public videos + privacy: VideoPrivacy.PUBLIC, + // Always list published videos, or videos that are being transcoded but on which we don't want to wait for transcoding + [ Sequelize.Op.or ]: [ + { + state: VideoState.PUBLISHED + }, + { + [ Sequelize.Op.and ]: { + state: VideoState.TO_TRANSCODE, + waitTranscoding: false + } } - } + ] }, - duration: { - type: DataTypes.INTEGER, - allowNull: false, - validate: { - durationValid: value => { - const res = isVideoDurationValid(value) - if (res === false) throw new Error('Video duration is not valid.') + include: [ videoChannelInclude ] + } + + if (options.actorId) { + let localVideosReq = '' + if (options.includeLocalVideos === true) { + localVideosReq = ' UNION ALL ' + + 'SELECT "video"."id" AS "id" FROM "video" ' + + 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + + 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' + + 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' + + 'WHERE "actor"."serverId" IS NULL' + } + + // Force actorId to be a number to avoid SQL injections + const actorIdNumber = parseInt(options.actorId.toString(), 10) + query.where['id'][ Sequelize.Op.in ] = Sequelize.literal( + '(' + + 'SELECT "videoShare"."videoId" AS "id" FROM "videoShare" ' + + 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' + + 'WHERE "actorFollow"."actorId" = ' + actorIdNumber + + ' UNION ALL ' + + 'SELECT "video"."id" AS "id" FROM "video" ' + + 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' + + 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' + + 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' + + 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "actor"."id" ' + + 'WHERE "actorFollow"."actorId" = ' + actorIdNumber + + localVideosReq + + ')' + ) + } + + if (options.withFiles === true) { + query.include.push({ + model: VideoFileModel.unscoped(), + required: true + }) + } + + // FIXME: issues with sequelize count when making a join on n:m relation, so we just make a IN() + if (options.tagsAllOf || options.tagsOneOf) { + const createTagsIn = (tags: string[]) => { + return tags.map(t => VideoModel.sequelize.escape(t)) + .join(', ') + } + + if (options.tagsOneOf) { + query.where['id'][Sequelize.Op.in] = Sequelize.literal( + '(' + + 'SELECT "videoId" FROM "videoTag" ' + + 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' + + 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsOneOf) + ')' + + ')' + ) + } + + if (options.tagsAllOf) { + query.where['id'][Sequelize.Op.in] = Sequelize.literal( + '(' + + 'SELECT "videoId" FROM "videoTag" ' + + 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' + + 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsAllOf) + ')' + + 'GROUP BY "videoTag"."videoId" HAVING COUNT(*) = ' + options.tagsAllOf.length + + ')' + ) + } + } + + if (options.nsfw === true || options.nsfw === false) { + query.where['nsfw'] = options.nsfw + } + + if (options.categoryOneOf) { + query.where['category'] = { + [Sequelize.Op.or]: options.categoryOneOf + } + } + + if (options.licenceOneOf) { + query.where['licence'] = { + [Sequelize.Op.or]: options.licenceOneOf + } + } + + if (options.languageOneOf) { + query.where['language'] = { + [Sequelize.Op.or]: options.languageOneOf + } + } + + if (options.accountId) { + accountInclude.where = { + id: options.accountId + } + } + + if (options.videoChannelId) { + videoChannelInclude.where = { + id: options.videoChannelId + } + } + + return query + }, + [ScopeNames.WITH_ACCOUNT_DETAILS]: { + include: [ + { + model: () => VideoChannelModel.unscoped(), + required: true, + include: [ + { + attributes: { + exclude: [ 'privateKey', 'publicKey' ] + }, + model: () => ActorModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'host' ], + model: () => ServerModel.unscoped(), + required: false + }, + { + model: () => AvatarModel.unscoped(), + required: false + } + ] + }, + { + model: () => AccountModel.unscoped(), + required: true, + include: [ + { + model: () => ActorModel.unscoped(), + attributes: { + exclude: [ 'privateKey', 'publicKey' ] + }, + required: true, + include: [ + { + attributes: [ 'host' ], + model: () => ServerModel.unscoped(), + required: false + }, + { + model: () => AvatarModel.unscoped(), + required: false + } + ] + } + ] } - } - }, - views: { - type: DataTypes.INTEGER, - allowNull: false, - defaultValue: 0, - validate: { - min: 0, - isInt: true - } - }, - likes: { - type: DataTypes.INTEGER, - allowNull: false, - defaultValue: 0, - validate: { - min: 0, - isInt: true - } - }, - dislikes: { - type: DataTypes.INTEGER, - allowNull: false, - defaultValue: 0, - validate: { - min: 0, - isInt: true - } - }, - remote: { - type: DataTypes.BOOLEAN, - allowNull: false, - defaultValue: false + ] + } + ] + }, + [ScopeNames.WITH_TAGS]: { + include: [ () => TagModel ] + }, + [ScopeNames.WITH_BLACKLISTED]: { + include: [ + { + attributes: [ 'id', 'reason' ], + model: () => VideoBlacklistModel, + required: false + } + ] + }, + [ScopeNames.WITH_FILES]: { + include: [ + { + model: () => VideoFileModel.unscoped(), + required: false } + ] + }, + [ScopeNames.WITH_SCHEDULED_UPDATE]: { + include: [ + { + model: () => ScheduleVideoUpdateModel.unscoped(), + required: false + } + ] + } +}) +@Table({ + tableName: 'video', + indexes +}) +export class VideoModel extends Model { + + @AllowNull(false) + @Default(DataType.UUIDV4) + @IsUUID(4) + @Column(DataType.UUID) + uuid: string + + @AllowNull(false) + @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name')) + @Column + name: string + + @AllowNull(true) + @Default(null) + @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category')) + @Column + category: number + + @AllowNull(true) + @Default(null) + @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence')) + @Column + licence: number + + @AllowNull(true) + @Default(null) + @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language')) + @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max)) + language: string + + @AllowNull(false) + @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy')) + @Column + privacy: number + + @AllowNull(false) + @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean')) + @Column + nsfw: boolean + + @AllowNull(true) + @Default(null) + @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description')) + @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max)) + description: string + + @AllowNull(true) + @Default(null) + @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support')) + @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max)) + support: string + + @AllowNull(false) + @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration')) + @Column + duration: number + + @AllowNull(false) + @Default(0) + @IsInt + @Min(0) + @Column + views: number + + @AllowNull(false) + @Default(0) + @IsInt + @Min(0) + @Column + likes: number + + @AllowNull(false) + @Default(0) + @IsInt + @Min(0) + @Column + dislikes: number + + @AllowNull(false) + @Column + remote: boolean + + @AllowNull(false) + @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url')) + @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max)) + url: string + + @AllowNull(false) + @Column + commentsEnabled: boolean + + @AllowNull(false) + @Column + waitTranscoding: boolean + + @AllowNull(false) + @Default(null) + @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state')) + @Column + state: VideoState + + @CreatedAt + createdAt: Date + + @UpdatedAt + updatedAt: Date + + @AllowNull(false) + @Default(Sequelize.NOW) + @Column + publishedAt: Date + + @ForeignKey(() => VideoChannelModel) + @Column + channelId: number + + @BelongsTo(() => VideoChannelModel, { + foreignKey: { + allowNull: true }, - { - indexes: [ - { - fields: [ 'authorId' ] - }, - { - fields: [ 'name' ] - }, - { - fields: [ 'createdAt' ] - }, - { - fields: [ 'duration' ] - }, - { - fields: [ 'views' ] - }, - { - fields: [ 'likes' ] - }, - { - fields: [ 'uuid' ] - } - ], - hooks: { - afterDestroy - } - } - ) - - const classMethods = [ - associate, - - generateThumbnailFromData, - getDurationFromFile, - list, - listForApi, - listOwnedAndPopulateAuthorAndTags, - listOwnedByAuthor, - load, - loadAndPopulateAuthor, - loadAndPopulateAuthorAndPodAndTags, - loadByHostAndUUID, - loadByUUID, - loadByUUIDAndPopulateAuthorAndPodAndTags, - searchAndPopulateAuthorAndPodAndTags - ] - const instanceMethods = [ - createPreview, - createThumbnail, - createTorrentAndSetInfoHash, - generateMagnetUri, - getPreviewName, - getThumbnailName, - getTorrentFileName, - getVideoFilename, - getVideoFilePath, - isOwned, - removeFile, - removePreview, - removeThumbnail, - removeTorrent, - toAddRemoteJSON, - toFormattedJSON, - toUpdateRemoteJSON, - transcodeVideofile - ] - addMethodsToModel(Video, classMethods, instanceMethods) - - return Video -} + hooks: true + }) + VideoChannel: VideoChannelModel -// ------------------------------ METHODS ------------------------------ + @BelongsToMany(() => TagModel, { + foreignKey: 'videoId', + through: () => VideoTagModel, + onDelete: 'CASCADE' + }) + Tags: TagModel[] -function associate (models) { - Video.belongsTo(models.Author, { + @HasMany(() => VideoAbuseModel, { foreignKey: { - name: 'authorId', + name: 'videoId', allowNull: false }, onDelete: 'cascade' }) + VideoAbuses: VideoAbuseModel[] - Video.belongsToMany(models.Tag, { - foreignKey: 'videoId', - through: models.VideoTag, + @HasMany(() => VideoFileModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, onDelete: 'cascade' }) + VideoFiles: VideoFileModel[] - Video.hasMany(models.VideoAbuse, { + @HasMany(() => VideoShareModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade' }) + VideoShares: VideoShareModel[] - Video.hasMany(models.VideoFile, { + @HasMany(() => AccountVideoRateModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade' }) -} + AccountVideoRates: AccountVideoRateModel[] -function afterDestroy (video: VideoInstance) { - const tasks = [] + @HasMany(() => VideoCommentModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade', + hooks: true + }) + VideoComments: VideoCommentModel[] - tasks.push( - video.removeThumbnail() - ) + @HasOne(() => ScheduleVideoUpdateModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade' + }) + ScheduleVideoUpdate: ScheduleVideoUpdateModel - if (video.isOwned()) { - const removeVideoToFriendsParams = { - uuid: video.uuid + @HasOne(() => VideoBlacklistModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade' + }) + VideoBlacklist: VideoBlacklistModel + + @HasMany(() => VideoCaptionModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade', + hooks: true, + ['separate' as any]: true + }) + VideoCaptions: VideoCaptionModel[] + + @BeforeDestroy + static async sendDelete (instance: VideoModel, options) { + if (instance.isOwned()) { + if (!instance.VideoChannel) { + instance.VideoChannel = await instance.$get('VideoChannel', { + include: [ + { + model: AccountModel, + include: [ ActorModel ] + } + ], + transaction: options.transaction + }) as VideoChannelModel + } + + return sendDeleteVideo(instance, options.transaction) } - tasks.push( - video.removePreview(), - removeVideoToFriends(removeVideoToFriendsParams) - ) + return undefined + } + + @BeforeDestroy + static async removeFiles (instance: VideoModel) { + const tasks: Promise[] = [] + + logger.info('Removing files of video %s.', instance.url) + + tasks.push(instance.removeThumbnail()) + + if (instance.isOwned()) { + if (!Array.isArray(instance.VideoFiles)) { + instance.VideoFiles = await instance.$get('VideoFiles') as VideoFileModel[] + } + + tasks.push(instance.removePreview()) + + // Remove physical files and torrents + instance.VideoFiles.forEach(file => { + tasks.push(instance.removeFile(file)) + tasks.push(instance.removeTorrent(file)) + }) + } + + // Do not wait video deletion because we could be in a transaction + Promise.all(tasks) + .catch(err => { + logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err }) + }) + + return undefined + } + + static list () { + return VideoModel.scope(ScopeNames.WITH_FILES).findAll() + } + + static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) { + function getRawQuery (select: string) { + const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' + + 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' + + 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' + + 'WHERE "Account"."actorId" = ' + actorId + const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' + + 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' + + 'WHERE "VideoShare"."actorId" = ' + actorId + + return `(${queryVideo}) UNION (${queryVideoShare})` + } + + const rawQuery = getRawQuery('"Video"."id"') + const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"') + + const query = { + distinct: true, + offset: start, + limit: count, + order: getSort('createdAt', [ 'Tags', 'name', 'ASC' ]), + where: { + id: { + [Sequelize.Op.in]: Sequelize.literal('(' + rawQuery + ')') + }, + [Sequelize.Op.or]: [ + { privacy: VideoPrivacy.PUBLIC }, + { privacy: VideoPrivacy.UNLISTED } + ] + }, + include: [ + { + attributes: [ 'language' ], + model: VideoCaptionModel.unscoped(), + required: false + }, + { + attributes: [ 'id', 'url' ], + model: VideoShareModel.unscoped(), + required: false, + // We only want videos shared by this actor + where: { + [Sequelize.Op.and]: [ + { + id: { + [Sequelize.Op.not]: null + } + }, + { + actorId + } + ] + }, + include: [ + { + attributes: [ 'id', 'url' ], + model: ActorModel.unscoped() + } + ] + }, + { + model: VideoChannelModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'name' ], + model: AccountModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'id', 'url', 'followersUrl' ], + model: ActorModel.unscoped(), + required: true + } + ] + }, + { + attributes: [ 'id', 'url', 'followersUrl' ], + model: ActorModel.unscoped(), + required: true + } + ] + }, + VideoFileModel, + TagModel + ] + } - // TODO: check files is populated - video.VideoFiles.forEach(file => { - video.removeFile(file), - video.removeTorrent(file) + return Bluebird.all([ + // FIXME: typing issue + VideoModel.findAll(query as any), + VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT }) + ]).then(([ rows, totals ]) => { + // totals: totalVideos + totalVideoShares + let totalVideos = 0 + let totalVideoShares = 0 + if (totals[0]) totalVideos = parseInt(totals[0].total, 10) + if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10) + + const total = totalVideos + totalVideoShares + return { + data: rows, + total: total + } }) } - return Promise.all(tasks) -} + static listUserVideosForApi (accountId: number, start: number, count: number, sort: string, withFiles = false) { + const query: IFindOptions = { + offset: start, + limit: count, + order: getSort(sort), + include: [ + { + model: VideoChannelModel, + required: true, + include: [ + { + model: AccountModel, + where: { + id: accountId + }, + required: true + } + ] + }, + { + model: ScheduleVideoUpdateModel, + required: false + }, + { + model: VideoBlacklistModel, + required: false + } + ] + } -getVideoFilename = function (this: VideoInstance, videoFile: VideoFileInstance) { - // return this.uuid + '-' + VIDEO_FILE_RESOLUTIONS[videoFile.resolution] + videoFile.extname - return this.uuid + videoFile.extname -} + if (withFiles === true) { + query.include.push({ + model: VideoFileModel.unscoped(), + required: true + }) + } -getThumbnailName = function (this: VideoInstance) { - // We always have a copy of the thumbnail - const extension = '.jpg' - return this.uuid + extension -} + return VideoModel.findAndCountAll(query).then(({ rows, count }) => { + return { + data: rows, + total: count + } + }) + } -getPreviewName = function (this: VideoInstance) { - const extension = '.jpg' - return this.uuid + extension -} + static async listForApi (options: { + start: number, + count: number, + sort: string, + nsfw: boolean, + includeLocalVideos: boolean, + withFiles: boolean, + categoryOneOf?: number[], + licenceOneOf?: number[], + languageOneOf?: string[], + tagsOneOf?: string[], + tagsAllOf?: string[], + filter?: VideoFilter, + accountId?: number, + videoChannelId?: number, + actorId?: number + }) { + const query = { + offset: options.start, + limit: options.count, + order: getSort(options.sort) + } -getTorrentFileName = function (this: VideoInstance, videoFile: VideoFileInstance) { - const extension = '.torrent' - // return this.uuid + '-' + VIDEO_FILE_RESOLUTIONS[videoFile.resolution] + extension - return this.uuid + extension -} + // actorId === null has a meaning, so just check undefined + const actorId = options.actorId !== undefined ? options.actorId : (await getServerActor()).id + + const scopes = { + method: [ + ScopeNames.AVAILABLE_FOR_LIST, { + actorId, + nsfw: options.nsfw, + categoryOneOf: options.categoryOneOf, + licenceOneOf: options.licenceOneOf, + languageOneOf: options.languageOneOf, + tagsOneOf: options.tagsOneOf, + tagsAllOf: options.tagsAllOf, + filter: options.filter, + withFiles: options.withFiles, + accountId: options.accountId, + videoChannelId: options.videoChannelId, + includeLocalVideos: options.includeLocalVideos + } as AvailableForListOptions + ] + } -isOwned = function (this: VideoInstance) { - return this.remote === false -} + return VideoModel.scope(scopes) + .findAndCountAll(query) + .then(({ rows, count }) => { + return { + data: rows, + total: count + } + }) + } -createPreview = function (this: VideoInstance, videoFile: VideoFileInstance) { - return generateImage(this, this.getVideoFilePath(videoFile), CONFIG.STORAGE.PREVIEWS_DIR, this.getPreviewName(), null) -} + static async searchAndPopulateAccountAndServer (options: { + includeLocalVideos: boolean + search?: string + start?: number + count?: number + sort?: string + startDate?: string // ISO 8601 + endDate?: string // ISO 8601 + nsfw?: boolean + categoryOneOf?: number[] + licenceOneOf?: number[] + languageOneOf?: string[] + tagsOneOf?: string[] + tagsAllOf?: string[] + durationMin?: number // seconds + durationMax?: number // seconds + }) { + const whereAnd = [ ] + + if (options.startDate || options.endDate) { + const publishedAtRange = { } + + if (options.startDate) publishedAtRange[Sequelize.Op.gte] = options.startDate + if (options.endDate) publishedAtRange[Sequelize.Op.lte] = options.endDate + + whereAnd.push({ publishedAt: publishedAtRange }) + } -createThumbnail = function (this: VideoInstance, videoFile: VideoFileInstance) { - return generateImage(this, this.getVideoFilePath(videoFile), CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName(), THUMBNAILS_SIZE) -} + if (options.durationMin || options.durationMax) { + const durationRange = { } -getVideoFilePath = function (this: VideoInstance, videoFile: VideoFileInstance) { - return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) -} + if (options.durationMin) durationRange[Sequelize.Op.gte] = options.durationMin + if (options.durationMax) durationRange[Sequelize.Op.lte] = options.durationMax -createTorrentAndSetInfoHash = function (this: VideoInstance, videoFile: VideoFileInstance) { - const options = { - announceList: [ - [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ] - ], - urlList: [ - CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) - ] + whereAnd.push({ duration: durationRange }) + } + + const attributesInclude = [] + const escapedSearch = VideoModel.sequelize.escape(options.search) + const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%') + if (options.search) { + whereAnd.push( + { + id: { + [ Sequelize.Op.in ]: Sequelize.literal( + '(' + + 'SELECT "video"."id" FROM "video" ' + + 'WHERE ' + + 'lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' + + 'lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' + + 'UNION ALL ' + + 'SELECT "video"."id" FROM "video" LEFT JOIN "videoTag" ON "videoTag"."videoId" = "video"."id" ' + + 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' + + 'WHERE "tag"."name" = ' + escapedSearch + + ')' + ) + } + } + ) + + attributesInclude.push(createSimilarityAttribute('VideoModel.name', options.search)) + } + + // Cannot search on similarity if we don't have a search + if (!options.search) { + attributesInclude.push( + Sequelize.literal('0 as similarity') + ) + } + + const query: IFindOptions = { + attributes: { + include: attributesInclude + }, + offset: options.start, + limit: options.count, + order: getSort(options.sort), + where: { + [ Sequelize.Op.and ]: whereAnd + } + } + + const serverActor = await getServerActor() + const scopes = { + method: [ + ScopeNames.AVAILABLE_FOR_LIST, { + actorId: serverActor.id, + includeLocalVideos: options.includeLocalVideos, + nsfw: options.nsfw, + categoryOneOf: options.categoryOneOf, + licenceOneOf: options.licenceOneOf, + languageOneOf: options.languageOneOf, + tagsOneOf: options.tagsOneOf, + tagsAllOf: options.tagsAllOf + } as AvailableForListOptions + ] + } + + return VideoModel.scope(scopes) + .findAndCountAll(query) + .then(({ rows, count }) => { + return { + data: rows, + total: count + } + }) + } + + static load (id: number, t?: Sequelize.Transaction) { + const options = t ? { transaction: t } : undefined + + return VideoModel.findById(id, options) + } + + static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) { + const query: IFindOptions = { + where: { + url + } + } + + if (t !== undefined) query.transaction = t + + return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query) + } + + static loadAndPopulateAccountAndServerAndTags (id: number) { + const options = { + order: [ [ 'Tags', 'name', 'ASC' ] ] + } + + return VideoModel + .scope([ + ScopeNames.WITH_TAGS, + ScopeNames.WITH_BLACKLISTED, + ScopeNames.WITH_FILES, + ScopeNames.WITH_ACCOUNT_DETAILS, + ScopeNames.WITH_SCHEDULED_UPDATE + ]) + .findById(id, options) + } + + static loadByUUID (uuid: string) { + const options = { + where: { + uuid + } + } + + return VideoModel + .scope([ ScopeNames.WITH_FILES ]) + .findOne(options) + } + + static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string, t?: Sequelize.Transaction) { + const options = { + order: [ [ 'Tags', 'name', 'ASC' ] ], + where: { + uuid + }, + transaction: t + } + + return VideoModel + .scope([ + ScopeNames.WITH_TAGS, + ScopeNames.WITH_BLACKLISTED, + ScopeNames.WITH_FILES, + ScopeNames.WITH_ACCOUNT_DETAILS, + ScopeNames.WITH_SCHEDULED_UPDATE + ]) + .findOne(options) } - return createTorrentPromise(this.getVideoFilePath(videoFile), options) - .then(torrent => { - const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) - return writeFilePromise(filePath, torrent).then(() => torrent) + static async getStats () { + const totalLocalVideos = await VideoModel.count({ + where: { + remote: false + } }) - .then(torrent => { - const parsedTorrent = parseTorrent(torrent) + const totalVideos = await VideoModel.count() - videoFile.infoHash = parsedTorrent.infoHash + let totalLocalVideoViews = await VideoModel.sum('views', { + where: { + remote: false + } }) -} + // Sequelize could return null... + if (!totalLocalVideoViews) totalLocalVideoViews = 0 + + return { + totalLocalVideos, + totalLocalVideoViews, + totalVideos + } + } -generateMagnetUri = function (this: VideoInstance, videoFile: VideoFileInstance) { - let baseUrlHttp - let baseUrlWs + private static buildActorWhereWithFilter (filter?: VideoFilter) { + if (filter && filter === 'local') { + return { + serverId: null + } + } - if (this.isOwned()) { - baseUrlHttp = CONFIG.WEBSERVER.URL - baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT - } else { - baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.Author.Pod.host - baseUrlWs = REMOTE_SCHEME.WS + '://' + this.Author.Pod.host + return {} } - const xs = baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile) - const announce = [ baseUrlWs + '/tracker/socket' ] - const urlList = [ baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) ] + private static getCategoryLabel (id: number) { + return VIDEO_CATEGORIES[id] || 'Misc' + } - const magnetHash = { - xs, - announce, - urlList, - infoHash: videoFile.infoHash, - name: this.name + private static getLicenceLabel (id: number) { + return VIDEO_LICENCES[id] || 'Unknown' } - return magnetUtil.encode(magnetHash) -} + private static getLanguageLabel (id: string) { + return VIDEO_LANGUAGES[id] || 'Unknown' + } -toFormattedJSON = function (this: VideoInstance) { - let podHost - - if (this.Author.Pod) { - podHost = this.Author.Pod.host - } else { - // It means it's our video - podHost = CONFIG.WEBSERVER.HOST - } - - // Maybe our pod is not up to date and there are new categories since our version - let categoryLabel = VIDEO_CATEGORIES[this.category] - if (!categoryLabel) categoryLabel = 'Misc' - - // Maybe our pod is not up to date and there are new licences since our version - let licenceLabel = VIDEO_LICENCES[this.licence] - if (!licenceLabel) licenceLabel = 'Unknown' - - // Language is an optional attribute - let languageLabel = VIDEO_LANGUAGES[this.language] - if (!languageLabel) languageLabel = 'Unknown' - - const json = { - id: this.id, - uuid: this.uuid, - name: this.name, - category: this.category, - categoryLabel, - licence: this.licence, - licenceLabel, - language: this.language, - languageLabel, - nsfw: this.nsfw, - description: this.description, - podHost, - isLocal: this.isOwned(), - author: this.Author.name, - duration: this.duration, - views: this.views, - likes: this.likes, - dislikes: this.dislikes, - tags: map(this.Tags, 'name'), - thumbnailPath: join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName()), - previewPath: join(STATIC_PATHS.PREVIEWS, this.getPreviewName()), - createdAt: this.createdAt, - updatedAt: this.updatedAt, - files: [] - } - - this.VideoFiles.forEach(videoFile => { - let resolutionLabel = VIDEO_FILE_RESOLUTIONS[videoFile.resolution] - if (!resolutionLabel) resolutionLabel = 'Unknown' - - const videoFileJson = { - resolution: videoFile.resolution, - resolutionLabel, - magnetUri: this.generateMagnetUri(videoFile), - size: videoFile.size - } - - json.files.push(videoFileJson) - }) + private static getPrivacyLabel (id: number) { + return VIDEO_PRIVACIES[id] || 'Unknown' + } - return json -} + private static getStateLabel (id: number) { + return VIDEO_STATES[id] || 'Unknown' + } + + getOriginalFile () { + if (Array.isArray(this.VideoFiles) === false) return undefined + + // The original file is the file that have the higher resolution + return maxBy(this.VideoFiles, file => file.resolution) + } + + getVideoFilename (videoFile: VideoFileModel) { + return this.uuid + '-' + videoFile.resolution + videoFile.extname + } + + getThumbnailName () { + // We always have a copy of the thumbnail + const extension = '.jpg' + return this.uuid + extension + } + + getPreviewName () { + const extension = '.jpg' + return this.uuid + extension + } + + getTorrentFileName (videoFile: VideoFileModel) { + const extension = '.torrent' + return this.uuid + '-' + videoFile.resolution + extension + } + + isOwned () { + return this.remote === false + } + + createPreview (videoFile: VideoFileModel) { + return generateImageFromVideoFile( + this.getVideoFilePath(videoFile), + CONFIG.STORAGE.PREVIEWS_DIR, + this.getPreviewName(), + PREVIEWS_SIZE + ) + } + + createThumbnail (videoFile: VideoFileModel) { + return generateImageFromVideoFile( + this.getVideoFilePath(videoFile), + CONFIG.STORAGE.THUMBNAILS_DIR, + this.getThumbnailName(), + THUMBNAILS_SIZE + ) + } + + getTorrentFilePath (videoFile: VideoFileModel) { + return join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) + } + + getVideoFilePath (videoFile: VideoFileModel) { + return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) + } + + async createTorrentAndSetInfoHash (videoFile: VideoFileModel) { + const options = { + // Keep the extname, it's used by the client to stream the file inside a web browser + name: `${this.name} ${videoFile.resolution}p${videoFile.extname}`, + createdBy: 'PeerTube', + announceList: [ + [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ], + [ CONFIG.WEBSERVER.URL + '/tracker/announce' ] + ], + urlList: [ + CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) + ] + } + + const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options) + + const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) + logger.info('Creating torrent %s.', filePath) + + await writeFile(filePath, torrent) + + const parsedTorrent = parseTorrent(torrent) + videoFile.infoHash = parsedTorrent.infoHash + } + + getEmbedStaticPath () { + return '/videos/embed/' + this.uuid + } -toAddRemoteJSON = function (this: VideoInstance) { - // Get thumbnail data to send to the other pod - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) + getThumbnailStaticPath () { + return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName()) + } + + getPreviewStaticPath () { + return join(STATIC_PATHS.PREVIEWS, this.getPreviewName()) + } + + toFormattedJSON (options?: { + additionalAttributes: { + state?: boolean, + waitTranscoding?: boolean, + scheduledUpdate?: boolean, + blacklistInfo?: boolean + } + }): Video { + const formattedAccount = this.VideoChannel.Account.toFormattedJSON() + const formattedVideoChannel = this.VideoChannel.toFormattedJSON() - return readFileBufferPromise(thumbnailPath).then(thumbnailData => { - const remoteVideo = { + const videoObject: Video = { + id: this.id, uuid: this.uuid, name: this.name, - category: this.category, - licence: this.licence, - language: this.language, + category: { + id: this.category, + label: VideoModel.getCategoryLabel(this.category) + }, + licence: { + id: this.licence, + label: VideoModel.getLicenceLabel(this.licence) + }, + language: { + id: this.language, + label: VideoModel.getLanguageLabel(this.language) + }, + privacy: { + id: this.privacy, + label: VideoModel.getPrivacyLabel(this.privacy) + }, nsfw: this.nsfw, - description: this.description, - author: this.Author.name, + description: this.getTruncatedDescription(), + isLocal: this.isOwned(), duration: this.duration, - thumbnailData: thumbnailData.toString('binary'), - tags: map(this.Tags, 'name'), - createdAt: this.createdAt, - updatedAt: this.updatedAt, views: this.views, likes: this.likes, dislikes: this.dislikes, - files: [] + thumbnailPath: this.getThumbnailStaticPath(), + previewPath: this.getPreviewStaticPath(), + embedPath: this.getEmbedStaticPath(), + createdAt: this.createdAt, + updatedAt: this.updatedAt, + publishedAt: this.publishedAt, + account: { + id: formattedAccount.id, + uuid: formattedAccount.uuid, + name: formattedAccount.name, + displayName: formattedAccount.displayName, + url: formattedAccount.url, + host: formattedAccount.host, + avatar: formattedAccount.avatar + }, + channel: { + id: formattedVideoChannel.id, + uuid: formattedVideoChannel.uuid, + name: formattedVideoChannel.name, + displayName: formattedVideoChannel.displayName, + url: formattedVideoChannel.url, + host: formattedVideoChannel.host, + avatar: formattedVideoChannel.avatar + } } - this.VideoFiles.forEach(videoFile => { - remoteVideo.files.push({ - infoHash: videoFile.infoHash, - resolution: videoFile.resolution, - extname: videoFile.extname, - size: videoFile.size - }) - }) + if (options) { + if (options.additionalAttributes.state === true) { + videoObject.state = { + id: this.state, + label: VideoModel.getStateLabel(this.state) + } + } - return remoteVideo - }) -} + if (options.additionalAttributes.waitTranscoding === true) { + videoObject.waitTranscoding = this.waitTranscoding + } -toUpdateRemoteJSON = function (this: VideoInstance) { - const json = { - uuid: this.uuid, - name: this.name, - category: this.category, - licence: this.licence, - language: this.language, - nsfw: this.nsfw, - description: this.description, - author: this.Author.name, - duration: this.duration, - tags: map(this.Tags, 'name'), - createdAt: this.createdAt, - updatedAt: this.updatedAt, - views: this.views, - likes: this.likes, - dislikes: this.dislikes, - files: [] - } - - this.VideoFiles.forEach(videoFile => { - json.files.push({ - infoHash: videoFile.infoHash, - resolution: videoFile.resolution, - extname: videoFile.extname, - size: videoFile.size + if (options.additionalAttributes.scheduledUpdate === true && this.ScheduleVideoUpdate) { + videoObject.scheduledUpdate = { + updateAt: this.ScheduleVideoUpdate.updateAt, + privacy: this.ScheduleVideoUpdate.privacy || undefined + } + } + + if (options.additionalAttributes.blacklistInfo === true) { + videoObject.blacklisted = !!this.VideoBlacklist + videoObject.blacklistedReason = this.VideoBlacklist ? this.VideoBlacklist.reason : null + } + } + + return videoObject + } + + toFormattedDetailsJSON (): VideoDetails { + const formattedJson = this.toFormattedJSON({ + additionalAttributes: { + scheduledUpdate: true, + blacklistInfo: true + } }) - }) - return json -} + const detailsJson = { + support: this.support, + descriptionPath: this.getDescriptionPath(), + channel: this.VideoChannel.toFormattedJSON(), + account: this.VideoChannel.Account.toFormattedJSON(), + tags: map(this.Tags, 'name'), + commentsEnabled: this.commentsEnabled, + waitTranscoding: this.waitTranscoding, + state: { + id: this.state, + label: VideoModel.getStateLabel(this.state) + }, + files: [] + } -transcodeVideofile = function (this: VideoInstance, inputVideoFile: VideoFileInstance) { - const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR - const newExtname = '.mp4' - const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile)) - const videoOutputPath = join(videosDirectory, this.id + '-transcoded' + newExtname) - - return new Promise((res, rej) => { - ffmpeg(videoInputPath) - .output(videoOutputPath) - .videoCodec('libx264') - .outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) - .outputOption('-movflags faststart') - .on('error', rej) - .on('end', () => { - - return unlinkPromise(videoInputPath) - .then(() => { - // Important to do this before getVideoFilename() to take in account the new file extension - inputVideoFile.set('extname', newExtname) - - return renamePromise(videoOutputPath, this.getVideoFilePath(inputVideoFile)) - }) - .then(() => { - return this.createTorrentAndSetInfoHash(inputVideoFile) - }) - .then(() => { - return inputVideoFile.save() - }) - .then(() => { - return res() - }) - .catch(err => { - // Autodestruction... - this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', err)) - - return rej(err) - }) - }) - .run() - }) -} + // Format and sort video files + detailsJson.files = this.getFormattedVideoFilesJSON() -removeThumbnail = function (this: VideoInstance) { - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) - return unlinkPromise(thumbnailPath) -} + return Object.assign(formattedJson, detailsJson) + } -removePreview = function (this: VideoInstance) { - // Same name than video thumbnail - return unlinkPromise(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName()) -} + getFormattedVideoFilesJSON (): VideoFile[] { + const { baseUrlHttp, baseUrlWs } = this.getBaseUrls() + + return this.VideoFiles + .map(videoFile => { + let resolutionLabel = videoFile.resolution + 'p' + + return { + resolution: { + id: videoFile.resolution, + label: resolutionLabel + }, + magnetUri: this.generateMagnetUri(videoFile, baseUrlHttp, baseUrlWs), + size: videoFile.size, + fps: videoFile.fps, + torrentUrl: this.getTorrentUrl(videoFile, baseUrlHttp), + torrentDownloadUrl: this.getTorrentDownloadUrl(videoFile, baseUrlHttp), + fileUrl: this.getVideoFileUrl(videoFile, baseUrlHttp), + fileDownloadUrl: this.getVideoFileDownloadUrl(videoFile, baseUrlHttp) + } as VideoFile + }) + .sort((a, b) => { + if (a.resolution.id < b.resolution.id) return 1 + if (a.resolution.id === b.resolution.id) return 0 + return -1 + }) + } -removeFile = function (this: VideoInstance, videoFile: VideoFileInstance) { - const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) - return unlinkPromise(filePath) -} + toActivityPubObject (): VideoTorrentObject { + const { baseUrlHttp, baseUrlWs } = this.getBaseUrls() + if (!this.Tags) this.Tags = [] -removeTorrent = function (this: VideoInstance, videoFile: VideoFileInstance) { - const torrenPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) - return unlinkPromise(torrenPath) -} + const tag = this.Tags.map(t => ({ + type: 'Hashtag' as 'Hashtag', + name: t.name + })) -// ------------------------------ STATICS ------------------------------ + let language + if (this.language) { + language = { + identifier: this.language, + name: VideoModel.getLanguageLabel(this.language) + } + } -generateThumbnailFromData = function (video: VideoInstance, thumbnailData: string) { - // Creating the thumbnail for a remote video + let category + if (this.category) { + category = { + identifier: this.category + '', + name: VideoModel.getCategoryLabel(this.category) + } + } - const thumbnailName = video.getThumbnailName() - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, thumbnailName) - return writeFilePromise(thumbnailPath, Buffer.from(thumbnailData, 'binary')).then(() => { - return thumbnailName - }) -} + let licence + if (this.licence) { + licence = { + identifier: this.licence + '', + name: VideoModel.getLicenceLabel(this.licence) + } + } + + const url = [] + for (const file of this.VideoFiles) { + url.push({ + type: 'Link', + mimeType: VIDEO_EXT_MIMETYPE[file.extname], + href: this.getVideoFileUrl(file, baseUrlHttp), + height: file.resolution, + size: file.size, + fps: file.fps + }) + + url.push({ + type: 'Link', + mimeType: 'application/x-bittorrent', + href: this.getTorrentUrl(file, baseUrlHttp), + height: file.resolution + }) -getDurationFromFile = function (videoPath: string) { - return new Promise((res, rej) => { - ffmpeg.ffprobe(videoPath, (err, metadata) => { - if (err) return rej(err) + url.push({ + type: 'Link', + mimeType: 'application/x-bittorrent;x-scheme-handler/magnet', + href: this.generateMagnetUri(file, baseUrlHttp, baseUrlWs), + height: file.resolution + }) + } - return res(Math.floor(metadata.format.duration)) + // Add video url too + url.push({ + type: 'Link', + mimeType: 'text/html', + href: CONFIG.WEBSERVER.URL + '/videos/watch/' + this.uuid }) - }) -} -list = function () { - const query = { - include: [ Video['sequelize'].models.VideoFile ] + const subtitleLanguage = [] + for (const caption of this.VideoCaptions) { + subtitleLanguage.push({ + identifier: caption.language, + name: VideoCaptionModel.getLanguageLabel(caption.language) + }) + } + + return { + type: 'Video' as 'Video', + id: this.url, + name: this.name, + duration: this.getActivityStreamDuration(), + uuid: this.uuid, + tag, + category, + licence, + language, + views: this.views, + sensitive: this.nsfw, + waitTranscoding: this.waitTranscoding, + state: this.state, + commentsEnabled: this.commentsEnabled, + published: this.publishedAt.toISOString(), + updated: this.updatedAt.toISOString(), + mediaType: 'text/markdown', + content: this.getTruncatedDescription(), + support: this.support, + subtitleLanguage, + icon: { + type: 'Image', + url: this.getThumbnailUrl(baseUrlHttp), + mediaType: 'image/jpeg', + width: THUMBNAILS_SIZE.width, + height: THUMBNAILS_SIZE.height + }, + url, + likes: getVideoLikesActivityPubUrl(this), + dislikes: getVideoDislikesActivityPubUrl(this), + shares: getVideoSharesActivityPubUrl(this), + comments: getVideoCommentsActivityPubUrl(this), + attributedTo: [ + { + type: 'Person', + id: this.VideoChannel.Account.Actor.url + }, + { + type: 'Group', + id: this.VideoChannel.Actor.url + } + ] + } } - return Video.findAll(query) -} + getTruncatedDescription () { + if (!this.description) return null -listForApi = function (start: number, count: number, sort: string) { - // Exclude blacklisted videos from the list - const query = { - distinct: true, - offset: start, - limit: count, - order: [ getSort(sort), [ Video['sequelize'].models.Tag, 'name', 'ASC' ] ], - include: [ - { - model: Video['sequelize'].models.Author, - include: [ { model: Video['sequelize'].models.Pod, required: false } ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ], - where: createBaseVideosWhere() + const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max + return peertubeTruncate(this.description, maxLength) } - return Video.findAndCountAll(query).then(({ rows, count }) => { - return { - data: rows, - total: count + async optimizeOriginalVideofile () { + const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR + const newExtname = '.mp4' + const inputVideoFile = this.getOriginalFile() + const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile)) + const videoTranscodedPath = join(videosDirectory, this.id + '-transcoded' + newExtname) + + const transcodeOptions = { + inputPath: videoInputPath, + outputPath: videoTranscodedPath } - }) -} -loadByHostAndUUID = function (fromHost: string, uuid: string) { - const query = { - where: { - uuid - }, - include: [ - { - model: Video['sequelize'].models.VideoFile - }, - { - model: Video['sequelize'].models.Author, - include: [ - { - model: Video['sequelize'].models.Pod, - required: true, - where: { - host: fromHost - } - } - ] - } - ] - } + // Could be very long! + await transcode(transcodeOptions) - return Video.findOne(query) -} + try { + await remove(videoInputPath) -listOwnedAndPopulateAuthorAndTags = function () { - const query = { - where: { - remote: false - }, - include: [ - Video['sequelize'].models.VideoFile, - Video['sequelize'].models.Author, - Video['sequelize'].models.Tag - ] - } + // Important to do this before getVideoFilename() to take in account the new file extension + inputVideoFile.set('extname', newExtname) - return Video.findAll(query) -} + const videoOutputPath = this.getVideoFilePath(inputVideoFile) + await rename(videoTranscodedPath, videoOutputPath) + const stats = await stat(videoOutputPath) + const fps = await getVideoFileFPS(videoOutputPath) -listOwnedByAuthor = function (author: string) { - const query = { - where: { - remote: false - }, - include: [ - { - model: Video['sequelize'].models.VideoFile - }, - { - model: Video['sequelize'].models.Author, - where: { - name: author - } - } - ] - } + inputVideoFile.set('size', stats.size) + inputVideoFile.set('fps', fps) - return Video.findAll(query) -} + await this.createTorrentAndSetInfoHash(inputVideoFile) + await inputVideoFile.save() -load = function (id: number) { - return Video.findById(id) -} + } catch (err) { + // Auto destruction... + this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err })) -loadByUUID = function (uuid: string) { - const query = { - where: { - uuid - }, - include: [ Video['sequelize'].models.VideoFile ] + throw err + } } - return Video.findOne(query) -} -loadAndPopulateAuthor = function (id: number) { - const options = { - include: [ Video['sequelize'].models.VideoFile, Video['sequelize'].models.Author ] + async transcodeOriginalVideofile (resolution: VideoResolution, isPortraitMode: boolean) { + const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR + const extname = '.mp4' + + // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed + const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile())) + + const newVideoFile = new VideoFileModel({ + resolution, + extname, + size: 0, + videoId: this.id + }) + const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile)) + + const transcodeOptions = { + inputPath: videoInputPath, + outputPath: videoOutputPath, + resolution, + isPortraitMode + } + + await transcode(transcodeOptions) + + const stats = await stat(videoOutputPath) + const fps = await getVideoFileFPS(videoOutputPath) + + newVideoFile.set('size', stats.size) + newVideoFile.set('fps', fps) + + await this.createTorrentAndSetInfoHash(newVideoFile) + + await newVideoFile.save() + + this.VideoFiles.push(newVideoFile) } - return Video.findById(id, options) -} + async importVideoFile (inputFilePath: string) { + const { videoFileResolution } = await getVideoFileResolution(inputFilePath) + const { size } = await stat(inputFilePath) + const fps = await getVideoFileFPS(inputFilePath) + + let updatedVideoFile = new VideoFileModel({ + resolution: videoFileResolution, + extname: extname(inputFilePath), + size, + fps, + videoId: this.id + }) -loadAndPopulateAuthorAndPodAndTags = function (id: number) { - const options = { - include: [ - { - model: Video['sequelize'].models.Author, - include: [ { model: Video['sequelize'].models.Pod, required: false } ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ] + const currentVideoFile = this.VideoFiles.find(videoFile => videoFile.resolution === updatedVideoFile.resolution) + + if (currentVideoFile) { + // Remove old file and old torrent + await this.removeFile(currentVideoFile) + await this.removeTorrent(currentVideoFile) + // Remove the old video file from the array + this.VideoFiles = this.VideoFiles.filter(f => f !== currentVideoFile) + + // Update the database + currentVideoFile.set('extname', updatedVideoFile.extname) + currentVideoFile.set('size', updatedVideoFile.size) + currentVideoFile.set('fps', updatedVideoFile.fps) + + updatedVideoFile = currentVideoFile + } + + const outputPath = this.getVideoFilePath(updatedVideoFile) + await copy(inputFilePath, outputPath) + + await this.createTorrentAndSetInfoHash(updatedVideoFile) + + await updatedVideoFile.save() + + this.VideoFiles.push(updatedVideoFile) } - return Video.findById(id, options) -} + getOriginalFileResolution () { + const originalFilePath = this.getVideoFilePath(this.getOriginalFile()) -loadByUUIDAndPopulateAuthorAndPodAndTags = function (uuid: string) { - const options = { - where: { - uuid - }, - include: [ - { - model: Video['sequelize'].models.Author, - include: [ { model: Video['sequelize'].models.Pod, required: false } ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ] + return getVideoFileResolution(originalFilePath) } - return Video.findOne(options) -} + getDescriptionPath () { + return `/api/${API_VERSION}/videos/${this.uuid}/description` + } -searchAndPopulateAuthorAndPodAndTags = function (value: string, field: string, start: number, count: number, sort: string) { - const podInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Pod, - required: false + removeThumbnail () { + const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) + return remove(thumbnailPath) + .catch(err => logger.warn('Cannot delete thumbnail %s.', thumbnailPath, { err })) } - const authorInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Author, - include: [ - podInclude - ] + removePreview () { + const previewPath = join(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName()) + return remove(previewPath) + .catch(err => logger.warn('Cannot delete preview %s.', previewPath, { err })) } - const tagInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Tag + removeFile (videoFile: VideoFileModel) { + const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) + return remove(filePath) + .catch(err => logger.warn('Cannot delete file %s.', filePath, { err })) } - const videoFileInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.VideoFile + removeTorrent (videoFile: VideoFileModel) { + const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) + return remove(torrentPath) + .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err })) } - const query: Sequelize.FindOptions = { - distinct: true, - where: createBaseVideosWhere(), - offset: start, - limit: count, - order: [ getSort(sort), [ Video['sequelize'].models.Tag, 'name', 'ASC' ] ] + getActivityStreamDuration () { + // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration + return 'PT' + this.duration + 'S' } - // Make an exact search with the magnet - if (field === 'magnetUri') { - videoFileInclude.where = { - infoHash: magnetUtil.decode(value).infoHash - } - } else if (field === 'tags') { - const escapedValue = Video['sequelize'].escape('%' + value + '%') - query.where['id'].$in = Video['sequelize'].literal( - `(SELECT "VideoTags"."videoId" - FROM "Tags" - INNER JOIN "VideoTags" ON "Tags"."id" = "VideoTags"."tagId" - WHERE name ILIKE ${escapedValue} - )` - ) - } else if (field === 'host') { - // FIXME: Include our pod? (not stored in the database) - podInclude.where = { - host: { - $iLike: '%' + value + '%' - } - } - podInclude.required = true - } else if (field === 'author') { - authorInclude.where = { - name: { - $iLike: '%' + value + '%' - } - } + isOutdated () { + if (this.isOwned()) return false - // authorInclude.or = true - } else { - query.where[field] = { - $iLike: '%' + value + '%' - } + const now = Date.now() + const createdAtTime = this.createdAt.getTime() + const updatedAtTime = this.updatedAt.getTime() + + return (now - createdAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL && + (now - updatedAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL } - query.include = [ - authorInclude, tagInclude, videoFileInclude - ] + private getBaseUrls () { + let baseUrlHttp + let baseUrlWs - return Video.findAndCountAll(query).then(({ rows, count }) => { - return { - data: rows, - total: count + if (this.isOwned()) { + baseUrlHttp = CONFIG.WEBSERVER.URL + baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + } else { + baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host + baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host } - }) -} -// --------------------------------------------------------------------------- + return { baseUrlHttp, baseUrlWs } + } -function createBaseVideosWhere () { - return { - id: { - $notIn: Video['sequelize'].literal( - '(SELECT "BlacklistedVideos"."videoId" FROM "BlacklistedVideos")' - ) - } + private getThumbnailUrl (baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName() } -} -function generateImage (video: VideoInstance, videoPath: string, folder: string, imageName: string, size: string) { - const options = { - filename: imageName, - count: 1, - folder + private getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile) } - if (size) { - options['size'] = size + private getTorrentDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + this.getTorrentFileName(videoFile) } - return new Promise((res, rej) => { - ffmpeg(videoPath) - .on('error', rej) - .on('end', () => res(imageName)) - .thumbnail(options) - }) + private getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) + } + + private getVideoFileDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + this.getVideoFilename(videoFile) + } + + private generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) { + const xs = this.getTorrentUrl(videoFile, baseUrlHttp) + const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ] + const urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ] + + const magnetHash = { + xs, + announce, + urlList, + infoHash: videoFile.infoHash, + name: this.name + } + + return magnetUtil.encode(magnetHash) + } }