X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo.ts;h=4e572a16b5f9ef62fcfb43dc8298bff5d4942249;hb=6d8c8ea73a774c3568e6d28a4cbebcf7979d5c2a;hp=27f59f3a9c920242ef34cf4d9c7d64f0c0bade34;hpb=c2962505115563ad1510e8116f3b362887cac71f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video.ts b/server/models/video/video.ts index 27f59f3a9..6c183933b 100644 --- a/server/models/video/video.ts +++ b/server/models/video/video.ts @@ -1,1103 +1,1600 @@ -import * as safeBuffer from 'safe-buffer' -const Buffer = safeBuffer.Buffer +import * as Bluebird from 'bluebird' +import { maxBy } from 'lodash' import * as magnetUtil from 'magnet-uri' -import { map } from 'lodash' import * as parseTorrent from 'parse-torrent' import { join } from 'path' import * as Sequelize from 'sequelize' -import * as Promise from 'bluebird' -import { maxBy } from 'lodash' - -import { TagInstance } from './tag-interface' import { - logger, - isVideoNameValid, + AllowNull, + BeforeDestroy, + BelongsTo, + BelongsToMany, + Column, + CreatedAt, + DataType, + Default, + ForeignKey, + HasMany, + HasOne, + IFindOptions, + IIncludeOptions, + Is, + IsInt, + IsUUID, + Min, + Model, + Scopes, + Table, + UpdatedAt +} from 'sequelize-typescript' +import { UserRight, VideoPrivacy, 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 { isArray, isBooleanValid } from '../../helpers/custom-validators/misc' +import { isVideoCategoryValid, - isVideoLicenceValid, - isVideoLanguageValid, - isVideoNSFWValid, isVideoDescriptionValid, isVideoDurationValid, - readFileBufferPromise, - unlinkPromise, - renamePromise, - writeFilePromise, - createTorrentPromise, - statPromise, - generateImageFromVideoFile, - transcode, - getVideoFileHeight -} from '../../helpers' + isVideoLanguageValid, + isVideoLicenceValid, + isVideoNameValid, + isVideoPrivacyValid, + isVideoStateValid, + isVideoSupportValid +} from '../../helpers/custom-validators/videos' +import { generateImageFromVideoFile, getVideoFileResolution } 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_LANGUAGES, - THUMBNAILS_SIZE + VIDEO_LICENCES, + VIDEO_PRIVACIES, + VIDEO_STATES } from '../../initializers' -import { removeVideoToFriends } from '../../lib' -import { VideoResolution } from '../../../shared' -import { VideoFileInstance, VideoFileModel } from './video-file-interface' - -import { addMethodsToModel, getSort } from '../utils' +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 { buildBlockedAccountSQL, buildTrigramSearchIndex, createSimilarityAttribute, getVideoSort, 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 { remove, writeFile } from 'fs-extra' +import { VideoViewModel } from './video-views' +import { VideoRedundancyModel } from '../redundancy/video-redundancy' import { - VideoInstance, - VideoAttributes, - - VideoMethods -} from './video-interface' -import { PREVIEWS_SIZE } from '../../initializers/constants' - -let Video: Sequelize.Model -let getOriginalFile: VideoMethods.GetOriginalFile -let getVideoFilename: VideoMethods.GetVideoFilename -let getThumbnailName: VideoMethods.GetThumbnailName -let getThumbnailPath: VideoMethods.GetThumbnailPath -let getPreviewName: VideoMethods.GetPreviewName -let getPreviewPath: VideoMethods.GetPreviewPath -let getTorrentFileName: VideoMethods.GetTorrentFileName -let isOwned: VideoMethods.IsOwned -let toFormattedJSON: VideoMethods.ToFormattedJSON -let toFormattedDetailsJSON: VideoMethods.ToFormattedDetailsJSON -let toAddRemoteJSON: VideoMethods.ToAddRemoteJSON -let toUpdateRemoteJSON: VideoMethods.ToUpdateRemoteJSON -let optimizeOriginalVideofile: VideoMethods.OptimizeOriginalVideofile -let transcodeOriginalVideofile: VideoMethods.TranscodeOriginalVideofile -let createPreview: VideoMethods.CreatePreview -let createThumbnail: VideoMethods.CreateThumbnail -let getVideoFilePath: VideoMethods.GetVideoFilePath -let createTorrentAndSetInfoHash: VideoMethods.CreateTorrentAndSetInfoHash -let getOriginalFileHeight: VideoMethods.GetOriginalFileHeight -let getEmbedPath: VideoMethods.GetEmbedPath - -let generateThumbnailFromData: VideoMethods.GenerateThumbnailFromData -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 loadLocalVideoByUUID: VideoMethods.LoadLocalVideoByUUID -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 + videoFilesModelToFormattedJSON, + VideoFormattingJSONOptions, + videoModelToActivityPubObject, + videoModelToFormattedDetailsJSON, + videoModelToFormattedJSON +} from './video-format-utils' +import * as validator from 'validator' +import { UserVideoHistoryModel } from '../account/user-video-history' +import { UserModel } from '../account/user' + +// 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_IDS = 'AVAILABLE_FOR_LIST_IDS', + FOR_API = 'FOR_API', + WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS', + WITH_TAGS = 'WITH_TAGS', + WITH_FILES = 'WITH_FILES', + WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE', + WITH_BLACKLISTED = 'WITH_BLACKLISTED', + WITH_USER_HISTORY = 'WITH_USER_HISTORY' +} + +type ForAPIOptions = { + ids: number[] + withFiles?: boolean +} + +type AvailableForListIDsOptions = { + serverAccountId: number + actorId: number + includeLocalVideos: boolean + filter?: VideoFilter + categoryOneOf?: number[] + nsfw?: boolean + licenceOneOf?: number[] + languageOneOf?: string[] + tagsOneOf?: string[] + tagsAllOf?: string[] + withFiles?: boolean + accountId?: number + videoChannelId?: number + trendingDays?: number + user?: UserModel +} + +@Scopes({ + [ ScopeNames.FOR_API ]: (options: ForAPIOptions) => { + const accountInclude = { + attributes: [ 'id', 'name' ], + model: AccountModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ], + model: ActorModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'host' ], + model: ServerModel.unscoped(), + required: false + }, + { + model: AvatarModel.unscoped(), + required: false + } + ] } - }, - name: { - type: DataTypes.STRING, - allowNull: false, - validate: { - nameValid: value => { - const res = isVideoNameValid(value) - if (res === false) throw new Error('Video name is not valid.') - } + ] + } + + const videoChannelInclude = { + attributes: [ 'name', 'description', 'id' ], + model: VideoChannelModel.unscoped(), + required: true, + 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 + ] + } + + const query: IFindOptions = { + where: { + id: { + [ Sequelize.Op.any ]: options.ids } }, - category: { - type: DataTypes.INTEGER, - allowNull: false, - validate: { - categoryValid: value => { - const res = isVideoCategoryValid(value) - if (res === false) throw new Error('Video category is not valid.') - } + include: [ videoChannelInclude ] + } + + if (options.withFiles === true) { + query.include.push({ + model: VideoFileModel.unscoped(), + required: true + }) + } + + return query + }, + [ ScopeNames.AVAILABLE_FOR_LIST_IDS ]: (options: AvailableForListIDsOptions) => { + const query: IFindOptions = { + raw: true, + attributes: [ 'id' ], + where: { + id: { + [ Sequelize.Op.and ]: [ + { + [ Sequelize.Op.notIn ]: Sequelize.literal( + '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")' + ) + } + ] + }, + channelId: { + [ Sequelize.Op.notIn ]: Sequelize.literal( + '(' + + 'SELECT id FROM "videoChannel" WHERE "accountId" IN (' + + buildBlockedAccountSQL(options.serverAccountId, options.user ? options.user.Account.id : undefined) + + ')' + + ')' + ) } }, - 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.') + include: [] + } + + // Only list public/published videos + if (!options.filter || options.filter !== 'all-local') { + const privacyWhere = { + // 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 + } } + ] + } + + Object.assign(query.where, privacyWhere) + } + + if (options.filter || options.accountId || options.videoChannelId) { + const videoChannelInclude: IIncludeOptions = { + attributes: [], + model: VideoChannelModel.unscoped(), + required: true + } + + if (options.videoChannelId) { + videoChannelInclude.where = { + id: options.videoChannelId } - }, - language: { - type: DataTypes.INTEGER, - allowNull: true, - validate: { - languageValid: value => { - const res = isVideoLanguageValid(value) - if (res === false) throw new Error('Video language is not valid.') - } + } + + if (options.filter || options.accountId) { + const accountInclude: IIncludeOptions = { + attributes: [], + model: AccountModel.unscoped(), + required: true } - }, - 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.') - } + + if (options.filter) { + accountInclude.include = [ + { + attributes: [], + model: ActorModel.unscoped(), + required: true, + where: VideoModel.buildActorWhereWithFilter(options.filter) + } + ] } - }, - description: { - type: DataTypes.STRING, - allowNull: false, - validate: { - descriptionValid: value => { - const res = isVideoDescriptionValid(value) - if (res === false) throw new Error('Video description is not valid.') - } + + if (options.accountId) { + accountInclude.where = { id: options.accountId } } - }, - duration: { - type: DataTypes.INTEGER, - allowNull: false, - validate: { - durationValid: value => { - const res = isVideoDurationValid(value) - if (res === false) throw new Error('Video duration is not valid.') + + videoChannelInclude.include = [ accountInclude ] + } + + query.include.push(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.and ].push({ + [ 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.where[ 'id' ][ Sequelize.Op.and ].push({ + [ Sequelize.Op.in ]: Sequelize.literal( + '(SELECT "videoId" FROM "videoFile")' + ) + }) + } + + // 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.and ].push({ + [ 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.and ].push({ + [ 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.trendingDays) { + query.include.push(VideoModel.buildTrendingQuery(options.trendingDays)) + + query.subQuery = false + } + + 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 + ] } - }, - { - indexes: [ - { - fields: [ 'name' ] - }, - { - fields: [ 'createdAt' ] - }, - { - fields: [ 'duration' ] - }, - { - fields: [ 'views' ] - }, - { - fields: [ 'likes' ] - }, - { - fields: [ 'uuid' ] - }, + ] + }, + [ ScopeNames.WITH_TAGS ]: { + include: [ () => TagModel ] + }, + [ ScopeNames.WITH_BLACKLISTED ]: { + include: [ + { + attributes: [ 'id', 'reason' ], + model: () => VideoBlacklistModel, + required: false + } + ] + }, + [ ScopeNames.WITH_FILES ]: { + include: [ + { + model: () => VideoFileModel.unscoped(), + // FIXME: typings + [ 'separate' as any ]: true, // We may have multiple files, having multiple redundancies so let's separate this join + required: false, + include: [ + { + attributes: [ 'fileUrl' ], + model: () => VideoRedundancyModel.unscoped(), + required: false + } + ] + } + ] + }, + [ ScopeNames.WITH_SCHEDULED_UPDATE ]: { + include: [ + { + model: () => ScheduleVideoUpdateModel.unscoped(), + required: false + } + ] + }, + [ ScopeNames.WITH_USER_HISTORY ]: (userId: number) => { + return { + include: [ { - fields: [ 'channelId' ] + attributes: [ 'currentTime' ], + model: UserVideoHistoryModel.unscoped(), + required: false, + where: { + userId + } } - ], - hooks: { - afterDestroy - } + ] } - ) - - const classMethods = [ - associate, - - generateThumbnailFromData, - list, - listForApi, - listOwnedAndPopulateAuthorAndTags, - listOwnedByAuthor, - load, - loadAndPopulateAuthor, - loadAndPopulateAuthorAndPodAndTags, - loadByHostAndUUID, - loadByUUID, - loadLocalVideoByUUID, - loadByUUIDAndPopulateAuthorAndPodAndTags, - searchAndPopulateAuthorAndPodAndTags - ] - const instanceMethods = [ - createPreview, - createThumbnail, - createTorrentAndSetInfoHash, - getPreviewName, - getPreviewPath, - getThumbnailName, - getThumbnailPath, - getTorrentFileName, - getVideoFilename, - getVideoFilePath, - getOriginalFile, - isOwned, - removeFile, - removePreview, - removeThumbnail, - removeTorrent, - toAddRemoteJSON, - toFormattedJSON, - toFormattedDetailsJSON, - toUpdateRemoteJSON, - optimizeOriginalVideofile, - transcodeOriginalVideofile, - getOriginalFileHeight, - getEmbedPath - ] - addMethodsToModel(Video, classMethods, instanceMethods) - - return Video -} + } +}) +@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 + }, + hooks: true + }) + VideoChannel: VideoChannelModel -// ------------------------------ METHODS ------------------------------ + @BelongsToMany(() => TagModel, { + foreignKey: 'videoId', + through: () => VideoTagModel, + onDelete: 'CASCADE' + }) + Tags: TagModel[] -function associate (models) { - Video.belongsTo(models.VideoChannel, { + @HasMany(() => VideoAbuseModel, { foreignKey: { - name: 'channelId', + name: 'videoId', allowNull: false }, onDelete: 'cascade' }) + VideoAbuses: VideoAbuseModel[] - Video.belongsToMany(models.Tag, { - foreignKey: 'videoId', - through: models.VideoTag, + @HasMany(() => VideoFileModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + hooks: true, 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() - ) + @HasMany(() => VideoViewModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade' + }) + VideoViews: VideoViewModel[] - if (video.isOwned()) { - const removeVideoToFriendsParams = { - uuid: video.uuid + @HasMany(() => UserVideoHistoryModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade' + }) + UserVideoHistories: UserVideoHistoryModel[] + + @HasOne(() => ScheduleVideoUpdateModel, { + foreignKey: { + name: 'videoId', + allowNull: false + }, + onDelete: 'cascade' + }) + ScheduleVideoUpdate: ScheduleVideoUpdateModel + + @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) + } + + 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 listLocal () { + const query = { + where: { + remote: false + } + } + + return VideoModel.scope(ScopeNames.WITH_FILES).findAll(query) + } + + 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: getVideoSort('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 + ] + } + + 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 + } + }) + } + + static listUserVideosForApi (accountId: number, start: number, count: number, sort: string, withFiles = false) { + const query: IFindOptions = { + offset: start, + limit: count, + order: getVideoSort(sort), + include: [ + { + model: VideoChannelModel, + required: true, + include: [ + { + model: AccountModel, + where: { + id: accountId + }, + required: true + } + ] + }, + { + model: ScheduleVideoUpdateModel, + required: false + }, + { + model: VideoBlacklistModel, + required: false + } + ] } - tasks.push( - video.removePreview(), - removeVideoToFriends(removeVideoToFriendsParams) - ) + if (withFiles === true) { + query.include.push({ + model: VideoFileModel.unscoped(), + required: true + }) + } - // Remove physical files and torrents - video.VideoFiles.forEach(file => { - tasks.push(video.removeFile(file)) - tasks.push(video.removeTorrent(file)) + return VideoModel.findAndCountAll(query).then(({ rows, count }) => { + return { + data: rows, + total: count + } }) } - return Promise.all(tasks) - .catch(err => { - logger.error('Some errors when removing files of video %s in after destroy hook.', video.uuid, err) - }) -} - -getOriginalFile = function (this: VideoInstance) { - if (Array.isArray(this.VideoFiles) === false) return undefined + 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 + trendingDays?: number, + user?: UserModel + }, countVideos = true) { + if (options.filter && options.filter === 'all-local' && !options.user.hasRight(UserRight.SEE_ALL_VIDEOS)) { + throw new Error('Try to filter all-local but no user has not the see all videos right') + } - // The original file is the file that have the higher resolution - return maxBy(this.VideoFiles, file => file.resolution) -} + const query: IFindOptions = { + offset: options.start, + limit: options.count, + order: getVideoSort(options.sort) + } -getVideoFilename = function (this: VideoInstance, videoFile: VideoFileInstance) { - return this.uuid + '-' + videoFile.resolution + videoFile.extname -} + let trendingDays: number + if (options.sort.endsWith('trending')) { + trendingDays = CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS -getThumbnailName = function (this: VideoInstance) { - // We always have a copy of the thumbnail - const extension = '.jpg' - return this.uuid + extension -} + query.group = 'VideoModel.id' + } -getPreviewName = function (this: VideoInstance) { - const extension = '.jpg' - return this.uuid + extension -} + const serverActor = await getServerActor() + + // actorId === null has a meaning, so just check undefined + const actorId = options.actorId !== undefined ? options.actorId : serverActor.id + + const queryOptions = { + actorId, + serverAccountId: serverActor.Account.id, + 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, + user: options.user, + trendingDays + } -getTorrentFileName = function (this: VideoInstance, videoFile: VideoFileInstance) { - const extension = '.torrent' - return this.uuid + '-' + videoFile.resolution + extension -} + return VideoModel.getAvailableForApi(query, queryOptions, countVideos) + } -isOwned = function (this: VideoInstance) { - return this.remote === false -} + 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 + user?: UserModel, + filter?: VideoFilter + }) { + 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 }) + } -createPreview = function (this: VideoInstance, videoFile: VideoFileInstance) { - const imageSize = PREVIEWS_SIZE.width + 'x' + PREVIEWS_SIZE.height + if (options.durationMin || options.durationMax) { + const durationRange = {} - return generateImageFromVideoFile( - this.getVideoFilePath(videoFile), - CONFIG.STORAGE.PREVIEWS_DIR, - this.getPreviewName(), - imageSize - ) -} + if (options.durationMin) durationRange[ Sequelize.Op.gte ] = options.durationMin + if (options.durationMax) durationRange[ Sequelize.Op.lte ] = options.durationMax -createThumbnail = function (this: VideoInstance, videoFile: VideoFileInstance) { - const imageSize = THUMBNAILS_SIZE.width + 'x' + THUMBNAILS_SIZE.height + whereAnd.push({ duration: durationRange }) + } - return generateImageFromVideoFile( - this.getVideoFilePath(videoFile), - CONFIG.STORAGE.THUMBNAILS_DIR, - this.getThumbnailName(), - imageSize - ) -} + 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 + + ')' + ) + } + } + ) -getVideoFilePath = function (this: VideoInstance, videoFile: VideoFileInstance) { - return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) -} + attributesInclude.push(createSimilarityAttribute('VideoModel.name', options.search)) + } -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) - ] - } + // Cannot search on similarity if we don't have a search + if (!options.search) { + attributesInclude.push( + Sequelize.literal('0 as similarity') + ) + } - return createTorrentPromise(this.getVideoFilePath(videoFile), options) - .then(torrent => { - const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) - logger.info('Creating torrent %s.', filePath) + const query: IFindOptions = { + attributes: { + include: attributesInclude + }, + offset: options.start, + limit: options.count, + order: getVideoSort(options.sort), + where: { + [ Sequelize.Op.and ]: whereAnd + } + } - return writeFilePromise(filePath, torrent).then(() => torrent) - }) - .then(torrent => { - const parsedTorrent = parseTorrent(torrent) + const serverActor = await getServerActor() + const queryOptions = { + actorId: serverActor.id, + serverAccountId: serverActor.Account.id, + includeLocalVideos: options.includeLocalVideos, + nsfw: options.nsfw, + categoryOneOf: options.categoryOneOf, + licenceOneOf: options.licenceOneOf, + languageOneOf: options.languageOneOf, + tagsOneOf: options.tagsOneOf, + tagsAllOf: options.tagsAllOf, + user: options.user, + filter: options.filter + } - videoFile.infoHash = parsedTorrent.infoHash - }) -} + return VideoModel.getAvailableForApi(query, queryOptions) + } -getEmbedPath = function (this: VideoInstance) { - return '/videos/embed/' + this.uuid -} + static load (id: number | string, t?: Sequelize.Transaction) { + const where = VideoModel.buildWhereIdOrUUID(id) + const options = { + where, + transaction: t + } -getThumbnailPath = function (this: VideoInstance) { - return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName()) -} + return VideoModel.findOne(options) + } -getPreviewPath = function (this: VideoInstance) { - return join(STATIC_PATHS.PREVIEWS, this.getPreviewName()) -} + static loadOnlyId (id: number | string, t?: Sequelize.Transaction) { + const where = VideoModel.buildWhereIdOrUUID(id) -toFormattedJSON = function (this: VideoInstance) { - let podHost + const options = { + attributes: [ 'id' ], + where, + transaction: t + } - if (this.VideoChannel.Author.Pod) { - podHost = this.VideoChannel.Author.Pod.host - } else { - // It means it's our video - podHost = CONFIG.WEBSERVER.HOST + return VideoModel.findOne(options) } - // 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.VideoChannel.Author.name, - duration: this.duration, - views: this.views, - likes: this.likes, - dislikes: this.dislikes, - tags: map(this.Tags, 'name'), - thumbnailPath: this.getThumbnailPath(), - previewPath: this.getPreviewPath(), - embedPath: this.getEmbedPath(), - createdAt: this.createdAt, - updatedAt: this.updatedAt + static loadWithFile (id: number, t?: Sequelize.Transaction, logging?: boolean) { + return VideoModel.scope(ScopeNames.WITH_FILES) + .findById(id, { transaction: t, logging }) } - return json -} + static loadByUUIDWithFile (uuid: string) { + const options = { + where: { + uuid + } + } + + return VideoModel + .scope([ ScopeNames.WITH_FILES ]) + .findOne(options) + } -toFormattedDetailsJSON = function (this: VideoInstance) { - let podHost + static loadByUrl (url: string, transaction?: Sequelize.Transaction) { + const query: IFindOptions = { + where: { + url + }, + transaction + } - if (this.VideoChannel.Author.Pod) { - podHost = this.VideoChannel.Author.Pod.host - } else { - // It means it's our video - podHost = CONFIG.WEBSERVER.HOST + return VideoModel.findOne(query) } - // 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.VideoChannel.Author.name, - duration: this.duration, - views: this.views, - likes: this.likes, - dislikes: this.dislikes, - tags: map(this.Tags, 'name'), - thumbnailPath: this.getThumbnailPath(), - previewPath: this.getPreviewPath(), - embedPath: this.getEmbedPath(), - createdAt: this.createdAt, - updatedAt: this.updatedAt, - channel: this.VideoChannel.toFormattedJSON(), - files: [] + static loadByUrlAndPopulateAccount (url: string, transaction?: Sequelize.Transaction) { + const query: IFindOptions = { + where: { + url + }, + transaction + } + + return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query) } - // Format and sort video files - const { baseUrlHttp, baseUrlWs } = getBaseUrls(this) - json.files = this.VideoFiles - .map(videoFile => { - let resolutionLabel = videoFile.resolution + 'p' - - const videoFileJson = { - resolution: videoFile.resolution, - resolutionLabel, - magnetUri: generateMagnetUri(this, videoFile, baseUrlHttp, baseUrlWs), - size: videoFile.size, - torrentUrl: getTorrentUrl(this, videoFile, baseUrlHttp), - fileUrl: getVideoFileUrl(this, videoFile, baseUrlHttp) - } - - return videoFileJson - }) - .sort((a, b) => { - if (a.resolution < b.resolution) return 1 - if (a.resolution === b.resolution) return 0 - return -1 - }) - - return json -} + static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Sequelize.Transaction, userId?: number) { + const where = VideoModel.buildWhereIdOrUUID(id) -toAddRemoteJSON = function (this: VideoInstance) { - // Get thumbnail data to send to the other pod - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) - - return readFileBufferPromise(thumbnailPath).then(thumbnailData => { - const remoteVideo = { - uuid: this.uuid, - name: this.name, - category: this.category, - licence: this.licence, - language: this.language, - nsfw: this.nsfw, - description: this.description, - channelUUID: this.VideoChannel.uuid, - 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: [] + const options = { + order: [ [ 'Tags', 'name', 'ASC' ] ], + where, + transaction: t } - this.VideoFiles.forEach(videoFile => { - remoteVideo.files.push({ - infoHash: videoFile.infoHash, - resolution: videoFile.resolution, - extname: videoFile.extname, - size: videoFile.size - }) - }) + const scopes = [ + ScopeNames.WITH_TAGS, + ScopeNames.WITH_BLACKLISTED, + ScopeNames.WITH_FILES, + ScopeNames.WITH_ACCOUNT_DETAILS, + ScopeNames.WITH_SCHEDULED_UPDATE + ] - return remoteVideo - }) -} + if (userId) { + scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] } as any) // FIXME: typings + } -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, - duration: this.duration, - tags: map(this.Tags, 'name'), - createdAt: this.createdAt, - updatedAt: this.updatedAt, - views: this.views, - likes: this.likes, - dislikes: this.dislikes, - files: [] + return VideoModel + .scope(scopes) + .findOne(options) } - this.VideoFiles.forEach(videoFile => { - json.files.push({ - infoHash: videoFile.infoHash, - resolution: videoFile.resolution, - extname: videoFile.extname, - size: videoFile.size + static async getStats () { + const totalLocalVideos = await VideoModel.count({ + where: { + remote: false + } }) - }) - - return json -} + const totalVideos = await VideoModel.count() -optimizeOriginalVideofile = function (this: VideoInstance) { - const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR - const newExtname = '.mp4' - const inputVideoFile = this.getOriginalFile() - const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile)) - const videoOutputPath = join(videosDirectory, this.id + '-transcoded' + newExtname) + let totalLocalVideoViews = await VideoModel.sum('views', { + where: { + remote: false + } + }) + // Sequelize could return null... + if (!totalLocalVideoViews) totalLocalVideoViews = 0 - const transcodeOptions = { - inputPath: videoInputPath, - outputPath: videoOutputPath + return { + totalLocalVideos, + totalLocalVideoViews, + totalVideos + } } - return transcode(transcodeOptions) - .then(() => { - return unlinkPromise(videoInputPath) + static incrementViews (id: number, views: number) { + return VideoModel.increment('views', { + by: views, + where: { + id + } }) - .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 statPromise(this.getVideoFilePath(inputVideoFile)) - }) - .then(stats => { - return inputVideoFile.set('size', stats.size) - }) - .then(() => { - return this.createTorrentAndSetInfoHash(inputVideoFile) - }) - .then(() => { - return inputVideoFile.save() - }) - .then(() => { - return undefined - }) - .catch(err => { - // Auto destruction... - this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', err)) + // threshold corresponds to how many video the field should have to be returned + static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) { + const serverActor = await getServerActor() + const actorId = serverActor.id - throw err - }) -} + const scopeOptions: AvailableForListIDsOptions = { + serverAccountId: serverActor.Account.id, + actorId, + includeLocalVideos: true + } -transcodeOriginalVideofile = function (this: VideoInstance, resolution: VideoResolution) { - const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR - const extname = '.mp4' + const query: IFindOptions = { + attributes: [ field ], + limit: count, + group: field, + having: Sequelize.where(Sequelize.fn('COUNT', Sequelize.col(field)), { + [ Sequelize.Op.gte ]: threshold + }) as any, // FIXME: typings + order: [ this.sequelize.random() ] + } - // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed - const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile())) + return VideoModel.scope({ method: [ ScopeNames.AVAILABLE_FOR_LIST_IDS, scopeOptions ] }) + .findAll(query) + .then(rows => rows.map(r => r[ field ])) + } - const newVideoFile = (Video['sequelize'].models.VideoFile as VideoFileModel).build({ - resolution, - extname, - size: 0, - videoId: this.id - }) - const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile)) + static buildTrendingQuery (trendingDays: number) { + return { + attributes: [], + subQuery: false, + model: VideoViewModel, + required: false, + where: { + startDate: { + [ Sequelize.Op.gte ]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays) + } + } + } + } + + private static buildActorWhereWithFilter (filter?: VideoFilter) { + if (filter && (filter === 'local' || filter === 'all-local')) { + return { + serverId: null + } + } - const transcodeOptions = { - inputPath: videoInputPath, - outputPath: videoOutputPath, - resolution + return {} } - return transcode(transcodeOptions) - .then(() => { - return statPromise(videoOutputPath) - }) - .then(stats => { - newVideoFile.set('size', stats.size) - return undefined - }) - .then(() => { - return this.createTorrentAndSetInfoHash(newVideoFile) - }) - .then(() => { - return newVideoFile.save() - }) - .then(() => { - return this.VideoFiles.push(newVideoFile) - }) - .then(() => undefined) -} + private static async getAvailableForApi ( + query: IFindOptions, + options: AvailableForListIDsOptions, + countVideos = true + ) { + const idsScope = { + method: [ + ScopeNames.AVAILABLE_FOR_LIST_IDS, options + ] + } -getOriginalFileHeight = function (this: VideoInstance) { - const originalFilePath = this.getVideoFilePath(this.getOriginalFile()) + // Remove trending sort on count, because it uses a group by + const countOptions = Object.assign({}, options, { trendingDays: undefined }) + const countQuery = Object.assign({}, query, { attributes: undefined, group: undefined }) + const countScope = { + method: [ + ScopeNames.AVAILABLE_FOR_LIST_IDS, countOptions + ] + } - return getVideoFileHeight(originalFilePath) -} + const [ count, rowsId ] = await Promise.all([ + countVideos ? VideoModel.scope(countScope).count(countQuery) : Promise.resolve(undefined), + VideoModel.scope(idsScope).findAll(query) + ]) + const ids = rowsId.map(r => r.id) -removeThumbnail = function (this: VideoInstance) { - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) - return unlinkPromise(thumbnailPath) -} + if (ids.length === 0) return { data: [], total: count } -removePreview = function (this: VideoInstance) { - // Same name than video thumbnail - return unlinkPromise(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName()) -} + // FIXME: typings + const apiScope: any[] = [ + { + method: [ ScopeNames.FOR_API, { ids, withFiles: options.withFiles } as ForAPIOptions ] + } + ] -removeFile = function (this: VideoInstance, videoFile: VideoFileInstance) { - const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) - return unlinkPromise(filePath) -} + if (options.user) { + apiScope.push({ method: [ ScopeNames.WITH_USER_HISTORY, options.user.id ] }) + } -removeTorrent = function (this: VideoInstance, videoFile: VideoFileInstance) { - const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) - return unlinkPromise(torrentPath) -} + const secondQuery = { + offset: 0, + limit: query.limit, + attributes: query.attributes, + order: [ // Keep original order + Sequelize.literal( + ids.map(id => `"VideoModel".id = ${id} DESC`).join(', ') + ) + ] + } + const rows = await VideoModel.scope(apiScope).findAll(secondQuery) -// ------------------------------ STATICS ------------------------------ + return { + data: rows, + total: count + } + } -generateThumbnailFromData = function (video: VideoInstance, thumbnailData: string) { - // Creating the thumbnail for a remote video + static getCategoryLabel (id: number) { + return VIDEO_CATEGORIES[ id ] || 'Misc' + } - const thumbnailName = video.getThumbnailName() - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, thumbnailName) - return writeFilePromise(thumbnailPath, Buffer.from(thumbnailData, 'binary')).then(() => { - return thumbnailName - }) -} + static getLicenceLabel (id: number) { + return VIDEO_LICENCES[ id ] || 'Unknown' + } -list = function () { - const query = { - include: [ Video['sequelize'].models.VideoFile ] + static getLanguageLabel (id: string) { + return VIDEO_LANGUAGES[ id ] || 'Unknown' } - return Video.findAll(query) -} + static getPrivacyLabel (id: number) { + return VIDEO_PRIVACIES[ id ] || 'Unknown' + } -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.VideoChannel, - include: [ - { - model: Video['sequelize'].models.Author, - include: [ - { - model: Video['sequelize'].models.Pod, - required: false - } - ] - } - ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ], - where: createBaseVideosWhere() + static getStateLabel (id: number) { + return VIDEO_STATES[ id ] || 'Unknown' } - return Video.findAndCountAll(query).then(({ rows, count }) => { - return { - data: rows, - total: count - } - }) -} + static buildWhereIdOrUUID (id: number | string) { + return validator.isInt('' + id) ? { id } : { uuid: id } + } -loadByHostAndUUID = function (fromHost: string, uuid: string, t?: Sequelize.Transaction) { - const query: Sequelize.FindOptions = { - where: { - uuid - }, - include: [ - { - model: Video['sequelize'].models.VideoFile - }, - { - model: Video['sequelize'].models.VideoChannel, - include: [ - { - model: Video['sequelize'].models.Author, - include: [ - { - model: Video['sequelize'].models.Pod, - required: true, - where: { - host: fromHost - } - } - ] - } - ] - } - ] + 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) } - if (t !== undefined) query.transaction = t + getVideoFilename (videoFile: VideoFileModel) { + return this.uuid + '-' + videoFile.resolution + videoFile.extname + } - return Video.findOne(query) -} + getThumbnailName () { + // We always have a copy of the thumbnail + const extension = '.jpg' + return this.uuid + extension + } -listOwnedAndPopulateAuthorAndTags = function () { - const query = { - where: { - remote: false - }, - include: [ - Video['sequelize'].models.VideoFile, - { - model: Video['sequelize'].models.VideoChannel, - include: [ Video['sequelize'].models.Author ] - }, - Video['sequelize'].models.Tag - ] + getPreviewName () { + const extension = '.jpg' + return this.uuid + extension } - return Video.findAll(query) -} + getTorrentFileName (videoFile: VideoFileModel) { + const extension = '.torrent' + return this.uuid + '-' + videoFile.resolution + extension + } -listOwnedByAuthor = function (author: string) { - const query = { - where: { - remote: false - }, - include: [ - { - model: Video['sequelize'].models.VideoFile - }, - { - model: Video['sequelize'].models.VideoChannel, - include: [ - { - model: Video['sequelize'].models.Author, - where: { - name: author - } - } - ] - } - ] + isOwned () { + return this.remote === false } - return Video.findAll(query) -} + createPreview (videoFile: VideoFileModel) { + return generateImageFromVideoFile( + this.getVideoFilePath(videoFile), + CONFIG.STORAGE.PREVIEWS_DIR, + this.getPreviewName(), + PREVIEWS_SIZE + ) + } -load = function (id: number) { - return Video.findById(id) -} + createThumbnail (videoFile: VideoFileModel) { + return generateImageFromVideoFile( + this.getVideoFilePath(videoFile), + CONFIG.STORAGE.THUMBNAILS_DIR, + this.getThumbnailName(), + THUMBNAILS_SIZE + ) + } -loadByUUID = function (uuid: string, t?: Sequelize.Transaction) { - const query: Sequelize.FindOptions = { - where: { - uuid - }, - include: [ Video['sequelize'].models.VideoFile ] + getTorrentFilePath (videoFile: VideoFileModel) { + return join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile)) } - if (t !== undefined) query.transaction = t + getVideoFilePath (videoFile: VideoFileModel) { + return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile)) + } - return Video.findOne(query) -} + 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) ] + } -loadLocalVideoByUUID = function (uuid: string, t?: Sequelize.Transaction) { - const query: Sequelize.FindOptions = { - where: { - uuid, - remote: false - }, - include: [ Video['sequelize'].models.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 } - if (t !== undefined) query.transaction = t + getEmbedStaticPath () { + return '/videos/embed/' + this.uuid + } - return Video.findOne(query) -} + getThumbnailStaticPath () { + return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName()) + } -loadAndPopulateAuthor = function (id: number) { - const options = { - include: [ - Video['sequelize'].models.VideoFile, - { - model: Video['sequelize'].models.VideoChannel, - include: [ Video['sequelize'].models.Author ] - } - ] + getPreviewStaticPath () { + return join(STATIC_PATHS.PREVIEWS, this.getPreviewName()) } - return Video.findById(id, options) -} + toFormattedJSON (options?: VideoFormattingJSONOptions): Video { + return videoModelToFormattedJSON(this, options) + } -loadAndPopulateAuthorAndPodAndTags = function (id: number) { - const options = { - include: [ - { - model: Video['sequelize'].models.VideoChannel, - include: [ - { - model: Video['sequelize'].models.Author, - include: [ { model: Video['sequelize'].models.Pod, required: false } ] - } - ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ] + toFormattedDetailsJSON (): VideoDetails { + return videoModelToFormattedDetailsJSON(this) } - return Video.findById(id, options) -} + getFormattedVideoFilesJSON (): VideoFile[] { + return videoFilesModelToFormattedJSON(this, this.VideoFiles) + } -loadByUUIDAndPopulateAuthorAndPodAndTags = function (uuid: string) { - const options = { - where: { - uuid - }, - include: [ - { - model: Video['sequelize'].models.VideoChannel, - include: [ - { - model: Video['sequelize'].models.Author, - include: [ { model: Video['sequelize'].models.Pod, required: false } ] - } - ] - }, - Video['sequelize'].models.Tag, - Video['sequelize'].models.VideoFile - ] + toActivityPubObject (): VideoTorrentObject { + return videoModelToActivityPubObject(this) } - return Video.findOne(options) -} + getTruncatedDescription () { + if (!this.description) return null -searchAndPopulateAuthorAndPodAndTags = function (value: string, field: string, start: number, count: number, sort: string) { - const podInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Pod, - required: false + const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max + return peertubeTruncate(this.description, maxLength) } - const authorInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Author, - include: [ podInclude ] + getOriginalFileResolution () { + const originalFilePath = this.getVideoFilePath(this.getOriginalFile()) + + return getVideoFileResolution(originalFilePath) } - const videoChannelInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.VideoChannel, - include: [ authorInclude ], - required: true + getDescriptionAPIPath () { + return `/api/${API_VERSION}/videos/${this.uuid}/description` } - const tagInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.Tag + removeThumbnail () { + const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName()) + return remove(thumbnailPath) + .catch(err => logger.warn('Cannot delete thumbnail %s.', thumbnailPath, { err })) } - const videoFileInclude: Sequelize.IncludeOptions = { - model: Video['sequelize'].models.VideoFile + removePreview () { + const previewPath = join(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName()) + return remove(previewPath) + .catch(err => logger.warn('Cannot delete preview %s.', previewPath, { err })) } - const query: Sequelize.FindOptions = { - distinct: true, - where: createBaseVideosWhere(), - offset: start, - limit: count, - order: [ getSort(sort), [ Video['sequelize'].models.Tag, 'name', 'ASC' ] ] + 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 })) } - // 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'][Sequelize.Op.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: { - [Sequelize.Op.iLike]: '%' + value + '%' - } - } - podInclude.required = true - } else if (field === 'author') { - authorInclude.where = { - name: { - [Sequelize.Op.iLike]: '%' + value + '%' - } - } - } else { - query.where[field] = { - [Sequelize.Op.iLike]: '%' + value + '%' - } + 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 })) } - query.include = [ - videoChannelInclude, tagInclude, videoFileInclude - ] + isOutdated () { + if (this.isOwned()) return false - return Video.findAndCountAll(query).then(({ rows, count }) => { - return { - data: rows, - total: count - } - }) -} + 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 + } -function createBaseVideosWhere () { - return { - id: { - [Sequelize.Op.notIn]: Video['sequelize'].literal( - '(SELECT "BlacklistedVideos"."videoId" FROM "BlacklistedVideos")' - ) + getBaseUrls () { + let baseUrlHttp + let baseUrlWs + + 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 getBaseUrls (video: VideoInstance) { - let baseUrlHttp - let baseUrlWs + generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) { + const xs = this.getTorrentUrl(videoFile, baseUrlHttp) + const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ] + let urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ] + + const redundancies = videoFile.RedundancyVideos + if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl)) + + const magnetHash = { + xs, + announce, + urlList, + infoHash: videoFile.infoHash, + name: this.name + } - if (video.isOwned()) { - baseUrlHttp = CONFIG.WEBSERVER.URL - baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT - } else { - baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + video.VideoChannel.Author.Pod.host - baseUrlWs = REMOTE_SCHEME.WS + '://' + video.VideoChannel.Author.Pod.host + return magnetUtil.encode(magnetHash) } - return { baseUrlHttp, baseUrlWs } -} + getThumbnailUrl (baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName() + } -function getTorrentUrl (video: VideoInstance, videoFile: VideoFileInstance, baseUrlHttp: string) { - return baseUrlHttp + STATIC_PATHS.TORRENTS + video.getTorrentFileName(videoFile) -} + getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile) + } -function getVideoFileUrl (video: VideoInstance, videoFile: VideoFileInstance, baseUrlHttp: string) { - return baseUrlHttp + STATIC_PATHS.WEBSEED + video.getVideoFilename(videoFile) -} + getTorrentDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + this.getTorrentFileName(videoFile) + } -function generateMagnetUri (video: VideoInstance, videoFile: VideoFileInstance, baseUrlHttp: string, baseUrlWs: string) { - const xs = getTorrentUrl(video, videoFile, baseUrlHttp) - const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ] - const urlList = [ getVideoFileUrl(video, videoFile, baseUrlHttp) ] - - const magnetHash = { - xs, - announce, - urlList, - infoHash: videoFile.infoHash, - name: video.name + getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile) } - return magnetUtil.encode(magnetHash) + getVideoFileDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) { + return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + this.getVideoFilename(videoFile) + } }