import * as Bluebird from 'bluebird' import { maxBy, minBy, pick } from 'lodash' import { join } from 'path' import { FindOptions, IncludeOptions, Op, QueryTypes, ScopeOptions, Sequelize, Transaction, WhereOptions } from 'sequelize' import { AllowNull, BeforeDestroy, BelongsTo, BelongsToMany, Column, CreatedAt, DataType, Default, ForeignKey, HasMany, HasOne, 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 } from '../../../shared/models/videos' import { VideoFilter } from '../../../shared/models/videos/video-query.type' import { peertubeTruncate } from '../../helpers/core-utils' import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc' import { isBooleanValid } from '../../helpers/custom-validators/misc' import { isVideoCategoryValid, isVideoDescriptionValid, isVideoDurationValid, isVideoLanguageValid, isVideoLicenceValid, isVideoNameValid, isVideoPrivacyValid, isVideoStateValid, isVideoSupportValid } from '../../helpers/custom-validators/videos' import { getVideoFileResolution } from '../../helpers/ffmpeg-utils' import { logger } from '../../helpers/logger' import { ACTIVITY_PUB, API_VERSION, CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, REMOTE_SCHEME, STATIC_DOWNLOAD_PATHS, STATIC_PATHS, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES, VIDEO_STATES, WEBSERVER } from '../../initializers/constants' 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, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils' import { TagModel } from './tag' import { VideoAbuseModel } from './video-abuse' import { ScopeNames as VideoChannelScopeNames, SummaryOptions, 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 } from 'fs-extra' import { VideoViewModel } from './video-views' import { VideoRedundancyModel } from '../redundancy/video-redundancy' import { videoFilesModelToFormattedJSON, VideoFormattingJSONOptions, videoModelToActivityPubObject, videoModelToFormattedDetailsJSON, videoModelToFormattedJSON } from './video-format-utils' import { UserVideoHistoryModel } from '../account/user-video-history' import { VideoImportModel } from './video-import' import { VideoStreamingPlaylistModel } from './video-streaming-playlist' import { VideoPlaylistElementModel } from './video-playlist-element' import { CONFIG } from '../../initializers/config' import { ThumbnailModel } from './thumbnail' import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type' import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type' import { MChannel, MChannelAccountDefault, MChannelId, MStreamingPlaylist, MStreamingPlaylistFilesVideo, MUserAccountId, MUserId, MVideoAccountLight, MVideoAccountLightBlacklistAllFiles, MVideoAP, MVideoDetails, MVideoFileVideo, MVideoFormattable, MVideoFormattableDetails, MVideoForUser, MVideoFullLight, MVideoIdThumbnail, MVideoImmutable, MVideoThumbnail, MVideoThumbnailBlacklist, MVideoWithAllFiles, MVideoWithFile, MVideoWithRights } from '../../typings/models' import { MVideoFile, MVideoFileStreamingPlaylistVideo } from '../../typings/models/video/video-file' import { MThumbnail } from '../../typings/models/video/thumbnail' import { VideoFile } from '@shared/models/videos/video-file.model' import { getHLSDirectory, getTorrentFileName, getTorrentFilePath, getVideoFilename, getVideoFilePath } from '@server/lib/video-paths' import { ModelCache } from '@server/models/model-cache' import { buildListQuery, BuildVideosQueryOptions, wrapForAPIResults } from './video-query-builder' import { buildNSFWFilter } from '@server/helpers/express-utils' import { getServerActor } from '@server/models/application/application' 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_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES', WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE', WITH_BLACKLISTED = 'WITH_BLACKLISTED', WITH_USER_HISTORY = 'WITH_USER_HISTORY', WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS', WITH_USER_ID = 'WITH_USER_ID', WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES', WITH_THUMBNAILS = 'WITH_THUMBNAILS' } export type ForAPIOptions = { ids?: number[] videoPlaylistId?: number withFiles?: boolean withAccountBlockerIds?: number[] } export type AvailableForListIDsOptions = { serverAccountId: number followerActorId: number includeLocalVideos: boolean attributesType?: 'none' | 'id' | 'all' filter?: VideoFilter categoryOneOf?: number[] nsfw?: boolean licenceOneOf?: number[] languageOneOf?: string[] tagsOneOf?: string[] tagsAllOf?: string[] withFiles?: boolean accountId?: number videoChannelId?: number videoPlaylistId?: number trendingDays?: number user?: MUserAccountId historyOfUser?: MUserId baseWhere?: WhereOptions[] } @Scopes(() => ({ [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: { attributes: [ 'id', 'url', 'uuid', 'remote' ] }, [ScopeNames.FOR_API]: (options: ForAPIOptions) => { const query: FindOptions = { include: [ { model: VideoChannelModel.scope({ method: [ VideoChannelScopeNames.SUMMARY, { withAccount: true, withAccountBlockerIds: options.withAccountBlockerIds } as SummaryOptions ] }), required: true }, { attributes: [ 'type', 'filename' ], model: ThumbnailModel, required: false } ] } if (options.ids) { query.where = { id: { [Op.in]: options.ids } } } if (options.withFiles === true) { query.include.push({ model: VideoFileModel, required: true }) } if (options.videoPlaylistId) { query.include.push({ model: VideoPlaylistElementModel.unscoped(), required: true, where: { videoPlaylistId: options.videoPlaylistId } }) } return query }, [ScopeNames.WITH_THUMBNAILS]: { include: [ { model: ThumbnailModel, required: false } ] }, [ScopeNames.WITH_USER_ID]: { include: [ { attributes: [ 'accountId' ], model: VideoChannelModel.unscoped(), required: true, include: [ { attributes: [ 'userId' ], model: AccountModel.unscoped(), required: true } ] } ] }, [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 } ] } ] } ] } ] }, [ScopeNames.WITH_TAGS]: { include: [ TagModel ] }, [ScopeNames.WITH_BLACKLISTED]: { include: [ { attributes: [ 'id', 'reason', 'unfederated' ], model: VideoBlacklistModel, required: false } ] }, [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => { let subInclude: any[] = [] if (withRedundancies === true) { subInclude = [ { attributes: [ 'fileUrl' ], model: VideoRedundancyModel.unscoped(), required: false } ] } return { include: [ { model: VideoFileModel, separate: true, // We may have multiple files, having multiple redundancies so let's separate this join required: false, include: subInclude } ] } }, [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => { const subInclude: IncludeOptions[] = [ { model: VideoFileModel, required: false } ] if (withRedundancies === true) { subInclude.push({ attributes: [ 'fileUrl' ], model: VideoRedundancyModel.unscoped(), required: false }) } return { include: [ { model: VideoStreamingPlaylistModel.unscoped(), separate: true, // We may have multiple streaming playlists, having multiple redundancies so let's separate this join required: false, include: subInclude } ] } }, [ScopeNames.WITH_SCHEDULED_UPDATE]: { include: [ { model: ScheduleVideoUpdateModel.unscoped(), required: false } ] }, [ScopeNames.WITH_USER_HISTORY]: (userId: number) => { return { include: [ { attributes: [ 'currentTime' ], model: UserVideoHistoryModel.unscoped(), required: false, where: { userId } } ] } } })) @Table({ tableName: 'video', indexes: [ buildTrigramSearchIndex('video_name_trigram', 'name'), { fields: [ 'createdAt' ] }, { fields: [ { name: 'publishedAt', order: 'DESC' }, { name: 'id', order: 'ASC' } ] }, { fields: [ 'duration' ] }, { fields: [ 'views' ] }, { fields: [ 'channelId' ] }, { fields: [ 'originallyPublishedAt' ], where: { originallyPublishedAt: { [Op.ne]: null } } }, { fields: [ 'category' ], // We don't care videos with an unknown category where: { category: { [Op.ne]: null } } }, { fields: [ 'licence' ], // We don't care videos with an unknown licence where: { licence: { [Op.ne]: null } } }, { fields: [ 'language' ], // We don't care videos with an unknown language where: { language: { [Op.ne]: null } } }, { fields: [ 'nsfw' ], // Most of the videos are not NSFW where: { nsfw: true } }, { fields: [ 'remote' ], // Only index local videos where: { remote: false } }, { fields: [ 'uuid' ], unique: true }, { fields: [ 'url' ], unique: true } ] }) 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', true)) @Column category: number @AllowNull(true) @Default(null) @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence', true)) @Column licence: number @AllowNull(true) @Default(null) @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language', true)) @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', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max)) description: string @AllowNull(true) @Default(null) @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true)) @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 downloadEnabled: 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(DataType.NOW) @Column publishedAt: Date @AllowNull(true) @Default(null) @Column originallyPublishedAt: Date @ForeignKey(() => VideoChannelModel) @Column channelId: number @BelongsTo(() => VideoChannelModel, { foreignKey: { allowNull: true }, hooks: true }) VideoChannel: VideoChannelModel @BelongsToMany(() => TagModel, { foreignKey: 'videoId', through: () => VideoTagModel, onDelete: 'CASCADE' }) Tags: TagModel[] @HasMany(() => ThumbnailModel, { foreignKey: { name: 'videoId', allowNull: true }, hooks: true, onDelete: 'cascade' }) Thumbnails: ThumbnailModel[] @HasMany(() => VideoPlaylistElementModel, { foreignKey: { name: 'videoId', allowNull: true }, onDelete: 'set null' }) VideoPlaylistElements: VideoPlaylistElementModel[] @HasMany(() => VideoAbuseModel, { foreignKey: { name: 'videoId', allowNull: true }, onDelete: 'set null' }) VideoAbuses: VideoAbuseModel[] @HasMany(() => VideoFileModel, { foreignKey: { name: 'videoId', allowNull: true }, hooks: true, onDelete: 'cascade' }) VideoFiles: VideoFileModel[] @HasMany(() => VideoStreamingPlaylistModel, { foreignKey: { name: 'videoId', allowNull: false }, hooks: true, onDelete: 'cascade' }) VideoStreamingPlaylists: VideoStreamingPlaylistModel[] @HasMany(() => VideoShareModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade' }) VideoShares: VideoShareModel[] @HasMany(() => AccountVideoRateModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade' }) AccountVideoRates: AccountVideoRateModel[] @HasMany(() => VideoCommentModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade', hooks: true }) VideoComments: VideoCommentModel[] @HasMany(() => VideoViewModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade' }) VideoViews: VideoViewModel[] @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 @HasOne(() => VideoImportModel, { foreignKey: { name: 'videoId', allowNull: true }, onDelete: 'set null' }) VideoImport: VideoImportModel @HasMany(() => VideoCaptionModel, { foreignKey: { name: 'videoId', allowNull: false }, onDelete: 'cascade', hooks: true, ['separate' as any]: true }) VideoCaptions: VideoCaptionModel[] @BeforeDestroy static async sendDelete (instance: MVideoAccountLight, options) { if (instance.isOwned()) { if (!instance.VideoChannel) { instance.VideoChannel = await instance.$get('VideoChannel', { include: [ ActorModel, AccountModel ], transaction: options.transaction }) as MChannelAccountDefault } 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) if (instance.isOwned()) { if (!Array.isArray(instance.VideoFiles)) { instance.VideoFiles = await instance.$get('VideoFiles') } // Remove physical files and torrents instance.VideoFiles.forEach(file => { tasks.push(instance.removeFile(file)) tasks.push(instance.removeTorrent(file)) }) // Remove playlists file if (!Array.isArray(instance.VideoStreamingPlaylists)) { instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists') } for (const p of instance.VideoStreamingPlaylists) { tasks.push(instance.removeStreamingPlaylistFiles(p)) } } // 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 } @BeforeDestroy static invalidateCache (instance: VideoModel) { ModelCache.Instance.invalidateCache('video', instance.id) } @BeforeDestroy static async saveEssentialDataToAbuses (instance: VideoModel, options) { const tasks: Promise[] = [] logger.info('Saving video abuses details of video %s.', instance.url) if (!Array.isArray(instance.VideoAbuses)) { instance.VideoAbuses = await instance.$get('VideoAbuses') if (instance.VideoAbuses.length === 0) return undefined } const details = instance.toFormattedDetailsJSON() for (const abuse of instance.VideoAbuses) { abuse.deletedVideo = details tasks.push(abuse.save({ transaction: options.transaction })) } Promise.all(tasks) .catch(err => { logger.error('Some errors when saving details of video %s in its abuses before destroy hook.', instance.uuid, { err }) }) return undefined } static listLocal (): Bluebird { const query = { where: { remote: false } } return VideoModel.scope([ ScopeNames.WITH_WEBTORRENT_FILES, ScopeNames.WITH_STREAMING_PLAYLISTS, ScopeNames.WITH_THUMBNAILS ]).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' ] as any), // FIXME: sequelize typings where: { id: { [Op.in]: Sequelize.literal('(' + rawQuery + ')') }, [Op.or]: [ { privacy: VideoPrivacy.PUBLIC }, { privacy: VideoPrivacy.UNLISTED } ] }, include: [ { attributes: [ 'language', 'fileUrl' ], model: VideoCaptionModel.unscoped(), required: false }, { attributes: [ 'id', 'url' ], model: VideoShareModel.unscoped(), required: false, // We only want videos shared by this actor where: { [Op.and]: [ { id: { [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([ VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query), VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: 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, search?: string ) { function buildBaseQuery (): FindOptions { let baseQuery = { offset: start, limit: count, order: getVideoSort(sort), include: [ { model: VideoChannelModel, required: true, include: [ { model: AccountModel, where: { id: accountId }, required: true } ] } ] } if (search) { baseQuery = Object.assign(baseQuery, { where: { name: { [Op.iLike]: '%' + search + '%' } } }) } return baseQuery } const countQuery = buildBaseQuery() const findQuery = buildBaseQuery() const findScopes: (string | ScopeOptions)[] = [ ScopeNames.WITH_SCHEDULED_UPDATE, ScopeNames.WITH_BLACKLISTED, ScopeNames.WITH_THUMBNAILS ] return Promise.all([ VideoModel.count(countQuery), VideoModel.scope(findScopes).findAll(findQuery) ]).then(([ count, rows ]) => { return { data: rows, total: count } }) } 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 followerActorId?: number videoPlaylistId?: number trendingDays?: number user?: MUserAccountId historyOfUser?: MUserId countVideos?: boolean }) { 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') } const trendingDays = options.sort.endsWith('trending') ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS : undefined const serverActor = await getServerActor() // followerActorId === null has a meaning, so just check undefined const followerActorId = options.followerActorId !== undefined ? options.followerActorId : serverActor.id const queryOptions = { start: options.start, count: options.count, sort: options.sort, followerActorId, 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, videoPlaylistId: options.videoPlaylistId, includeLocalVideos: options.includeLocalVideos, user: options.user, historyOfUser: options.historyOfUser, trendingDays } return VideoModel.getAvailableForApi(queryOptions, options.countVideos) } static async searchAndPopulateAccountAndServer (options: { includeLocalVideos: boolean search?: string start?: number count?: number sort?: string startDate?: string // ISO 8601 endDate?: string // ISO 8601 originallyPublishedStartDate?: string originallyPublishedEndDate?: string nsfw?: boolean categoryOneOf?: number[] licenceOneOf?: number[] languageOneOf?: string[] tagsOneOf?: string[] tagsAllOf?: string[] durationMin?: number // seconds durationMax?: number // seconds user?: MUserAccountId filter?: VideoFilter }) { const serverActor = await getServerActor() const queryOptions = { followerActorId: 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, start: options.start, count: options.count, sort: options.sort, startDate: options.startDate, endDate: options.endDate, originallyPublishedStartDate: options.originallyPublishedStartDate, originallyPublishedEndDate: options.originallyPublishedEndDate, durationMin: options.durationMin, durationMax: options.durationMax, search: options.search } return VideoModel.getAvailableForApi(queryOptions) } static load (id: number | string, t?: Transaction): Bluebird { const where = buildWhereIdOrUUID(id) const options = { where, transaction: t } return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options) } static loadWithBlacklist (id: number | string, t?: Transaction): Bluebird { const where = buildWhereIdOrUUID(id) const options = { where, transaction: t } return VideoModel.scope([ ScopeNames.WITH_THUMBNAILS, ScopeNames.WITH_BLACKLISTED ]).findOne(options) } static loadImmutableAttributes (id: number | string, t?: Transaction): Bluebird { const fun = () => { const query = { where: buildWhereIdOrUUID(id), transaction: t } return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query) } return ModelCache.Instance.doCache({ cacheType: 'load-video-immutable-id', key: '' + id, deleteKey: 'video', fun }) } static loadWithRights (id: number | string, t?: Transaction): Bluebird { const where = buildWhereIdOrUUID(id) const options = { where, transaction: t } return VideoModel.scope([ ScopeNames.WITH_BLACKLISTED, ScopeNames.WITH_USER_ID, ScopeNames.WITH_THUMBNAILS ]).findOne(options) } static loadOnlyId (id: number | string, t?: Transaction): Bluebird { const where = buildWhereIdOrUUID(id) const options = { attributes: [ 'id' ], where, transaction: t } return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options) } static loadWithFiles (id: number | string, t?: Transaction, logging?: boolean): Bluebird { const where = buildWhereIdOrUUID(id) const query = { where, transaction: t, logging } return VideoModel.scope([ ScopeNames.WITH_WEBTORRENT_FILES, ScopeNames.WITH_STREAMING_PLAYLISTS, ScopeNames.WITH_THUMBNAILS ]).findOne(query) } static loadByUUID (uuid: string): Bluebird { const options = { where: { uuid } } return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(options) } static loadByUrl (url: string, transaction?: Transaction): Bluebird { const query: FindOptions = { where: { url }, transaction } return VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findOne(query) } static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Bluebird { const fun = () => { const query: FindOptions = { where: { url }, transaction } return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query) } return ModelCache.Instance.doCache({ cacheType: 'load-video-immutable-url', key: url, deleteKey: 'video', fun }) } static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Bluebird { const query: FindOptions = { where: { url }, transaction } return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_WEBTORRENT_FILES, ScopeNames.WITH_STREAMING_PLAYLISTS, ScopeNames.WITH_THUMBNAILS, ScopeNames.WITH_BLACKLISTED ]).findOne(query) } static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Bluebird { const where = buildWhereIdOrUUID(id) const options = { order: [ [ 'Tags', 'name', 'ASC' ] ] as any, where, transaction: t } const scopes: (string | ScopeOptions)[] = [ ScopeNames.WITH_TAGS, ScopeNames.WITH_BLACKLISTED, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE, ScopeNames.WITH_WEBTORRENT_FILES, ScopeNames.WITH_STREAMING_PLAYLISTS, ScopeNames.WITH_THUMBNAILS ] if (userId) { scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] }) } return VideoModel .scope(scopes) .findOne(options) } static loadForGetAPI (parameters: { id: number | string t?: Transaction userId?: number }): Bluebird { const { id, t, userId } = parameters const where = buildWhereIdOrUUID(id) const options = { order: [ [ 'Tags', 'name', 'ASC' ] ] as any, // FIXME: sequelize typings where, transaction: t } const scopes: (string | ScopeOptions)[] = [ ScopeNames.WITH_TAGS, ScopeNames.WITH_BLACKLISTED, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE, ScopeNames.WITH_THUMBNAILS, { method: [ ScopeNames.WITH_WEBTORRENT_FILES, true ] }, { method: [ ScopeNames.WITH_STREAMING_PLAYLISTS, true ] } ] if (userId) { scopes.push({ method: [ ScopeNames.WITH_USER_HISTORY, userId ] }) } return VideoModel .scope(scopes) .findOne(options) } static async getStats () { const totalLocalVideos = await VideoModel.count({ where: { remote: false } }) let totalLocalVideoViews = await VideoModel.sum('views', { where: { remote: false } }) // Sequelize could return null... if (!totalLocalVideoViews) totalLocalVideoViews = 0 const { total: totalVideos } = await VideoModel.listForApi({ start: 0, count: 0, sort: '-publishedAt', nsfw: buildNSFWFilter(), includeLocalVideos: true, withFiles: false }) return { totalLocalVideos, totalLocalVideoViews, totalVideos } } static incrementViews (id: number, views: number) { return VideoModel.increment('views', { by: views, where: { id } }) } static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) { // Instances only share videos const query = 'SELECT 1 FROM "videoShare" ' + 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' + 'WHERE "actorFollow"."actorId" = $followerActorId AND "videoShare"."videoId" = $videoId ' + 'LIMIT 1' const options = { type: QueryTypes.SELECT as QueryTypes.SELECT, bind: { followerActorId, videoId }, raw: true } return VideoModel.sequelize.query(query, options) .then(results => results.length === 1) } static bulkUpdateSupportField (videoChannel: MChannel, t: Transaction) { const options = { where: { channelId: videoChannel.id }, transaction: t } return VideoModel.update({ support: videoChannel.support }, options) } static getAllIdsFromChannel (videoChannel: MChannelId): Bluebird { const query = { attributes: [ 'id' ], where: { channelId: videoChannel.id } } return VideoModel.findAll(query) .then(videos => videos.map(v => v.id)) } // 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 followerActorId = serverActor.id const queryOptions: BuildVideosQueryOptions = { attributes: [ `"${field}"` ], group: `GROUP BY "${field}"`, having: `HAVING COUNT("${field}") >= ${threshold}`, start: 0, sort: 'random', count, serverAccountId: serverActor.Account.id, followerActorId, includeLocalVideos: true } const { query, replacements } = buildListQuery(VideoModel, queryOptions) return this.sequelize.query(query, { replacements, type: QueryTypes.SELECT }) .then(rows => rows.map(r => r[field])) } static buildTrendingQuery (trendingDays: number) { return { attributes: [], subQuery: false, model: VideoViewModel, required: false, where: { startDate: { [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays) } } } } private static async getAvailableForApi ( options: BuildVideosQueryOptions, countVideos = true ) { function getCount () { if (countVideos !== true) return Promise.resolve(undefined) const countOptions = Object.assign({}, options, { isCount: true }) const { query: queryCount, replacements: replacementsCount } = buildListQuery(VideoModel, countOptions) return VideoModel.sequelize.query(queryCount, { replacements: replacementsCount, type: QueryTypes.SELECT }) .then(rows => rows.length !== 0 ? rows[0].total : 0) } function getModels () { if (options.count === 0) return Promise.resolve([]) const { query, replacements, order } = buildListQuery(VideoModel, options) const queryModels = wrapForAPIResults(query, replacements, options, order) return VideoModel.sequelize.query(queryModels, { replacements, type: QueryTypes.SELECT, nest: true }) .then(rows => VideoModel.buildAPIResult(rows)) } const [ count, rows ] = await Promise.all([ getCount(), getModels() ]) return { data: rows, total: count } } private static buildAPIResult (rows: any[]) { const memo: { [ id: number ]: VideoModel } = {} const thumbnailsDone = new Set() const historyDone = new Set() const videoFilesDone = new Set() const videos: VideoModel[] = [] const avatarKeys = [ 'id', 'filename', 'fileUrl', 'onDisk', 'createdAt', 'updatedAt' ] const actorKeys = [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ] const serverKeys = [ 'id', 'host' ] const videoFileKeys = [ 'id', 'createdAt', 'updatedAt', 'resolution', 'size', 'extname', 'infoHash', 'fps', 'videoId' ] const videoKeys = [ 'id', 'uuid', 'name', 'category', 'licence', 'language', 'privacy', 'nsfw', 'description', 'support', 'duration', 'views', 'likes', 'dislikes', 'remote', 'url', 'commentsEnabled', 'downloadEnabled', 'waitTranscoding', 'state', 'publishedAt', 'originallyPublishedAt', 'channelId', 'createdAt', 'updatedAt' ] function buildActor (rowActor: any) { const avatarModel = rowActor.Avatar.id !== null ? new AvatarModel(pick(rowActor.Avatar, avatarKeys)) : null const serverModel = rowActor.Server.id !== null ? new ServerModel(pick(rowActor.Server, serverKeys)) : null const actorModel = new ActorModel(pick(rowActor, actorKeys)) actorModel.Avatar = avatarModel actorModel.Server = serverModel return actorModel } for (const row of rows) { if (!memo[row.id]) { // Build Channel const channel = row.VideoChannel const channelModel = new VideoChannelModel(pick(channel, [ 'id', 'name', 'description', 'actorId' ])) channelModel.Actor = buildActor(channel.Actor) const account = row.VideoChannel.Account const accountModel = new AccountModel(pick(account, [ 'id', 'name' ])) accountModel.Actor = buildActor(account.Actor) channelModel.Account = accountModel const videoModel = new VideoModel(pick(row, videoKeys)) videoModel.VideoChannel = channelModel videoModel.UserVideoHistories = [] videoModel.Thumbnails = [] videoModel.VideoFiles = [] memo[row.id] = videoModel // Don't take object value to have a sorted array videos.push(videoModel) } const videoModel = memo[row.id] if (row.userVideoHistory?.id && !historyDone.has(row.userVideoHistory.id)) { const historyModel = new UserVideoHistoryModel(pick(row.userVideoHistory, [ 'id', 'currentTime' ])) videoModel.UserVideoHistories.push(historyModel) historyDone.add(row.userVideoHistory.id) } if (row.Thumbnails?.id && !thumbnailsDone.has(row.Thumbnails.id)) { const thumbnailModel = new ThumbnailModel(pick(row.Thumbnails, [ 'id', 'type', 'filename' ])) videoModel.Thumbnails.push(thumbnailModel) thumbnailsDone.add(row.Thumbnails.id) } if (row.VideoFiles?.id && !videoFilesDone.has(row.VideoFiles.id)) { const videoFileModel = new VideoFileModel(pick(row.VideoFiles, videoFileKeys)) videoModel.VideoFiles.push(videoFileModel) videoFilesDone.add(row.VideoFiles.id) } } return videos } private static isPrivacyForFederation (privacy: VideoPrivacy) { const castedPrivacy = parseInt(privacy + '', 10) return castedPrivacy === VideoPrivacy.PUBLIC || castedPrivacy === VideoPrivacy.UNLISTED } static getCategoryLabel (id: number) { return VIDEO_CATEGORIES[id] || 'Misc' } static getLicenceLabel (id: number) { return VIDEO_LICENCES[id] || 'Unknown' } static getLanguageLabel (id: string) { return VIDEO_LANGUAGES[id] || 'Unknown' } static getPrivacyLabel (id: number) { return VIDEO_PRIVACIES[id] || 'Unknown' } static getStateLabel (id: number) { return VIDEO_STATES[id] || 'Unknown' } isBlacklisted () { return !!this.VideoBlacklist } isBlocked () { return (this.VideoChannel.Account.Actor.Server && this.VideoChannel.Account.Actor.Server.isBlocked()) || this.VideoChannel.Account.isBlocked() } getQualityFileBy (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) { if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) { const file = fun(this.VideoFiles, file => file.resolution) return Object.assign(file, { Video: this }) } // No webtorrent files, try with streaming playlist files if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) { const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this }) const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution) return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo }) } return undefined } getMaxQualityFile (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo { return this.getQualityFileBy(maxBy) } getMinQualityFile (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo { return this.getQualityFileBy(minBy) } getWebTorrentFile (this: T, resolution: number): MVideoFileVideo { if (Array.isArray(this.VideoFiles) === false) return undefined const file = this.VideoFiles.find(f => f.resolution === resolution) if (!file) return undefined return Object.assign(file, { Video: this }) } async addAndSaveThumbnail (thumbnail: MThumbnail, transaction: Transaction) { thumbnail.videoId = this.id const savedThumbnail = await thumbnail.save({ transaction }) if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = [] // Already have this thumbnail, skip if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return this.Thumbnails.push(savedThumbnail) } generateThumbnailName () { return this.uuid + '.jpg' } getMiniature () { if (Array.isArray(this.Thumbnails) === false) return undefined return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE) } generatePreviewName () { return this.uuid + '.jpg' } hasPreview () { return !!this.getPreview() } getPreview () { if (Array.isArray(this.Thumbnails) === false) return undefined return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW) } isOwned () { return this.remote === false } getWatchStaticPath () { return '/videos/watch/' + this.uuid } getEmbedStaticPath () { return '/videos/embed/' + this.uuid } getMiniatureStaticPath () { const thumbnail = this.getMiniature() if (!thumbnail) return null return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename) } getPreviewStaticPath () { const preview = this.getPreview() if (!preview) return null // We use a local cache, so specify our cache endpoint instead of potential remote URL return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename) } toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video { return videoModelToFormattedJSON(this, options) } toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails { return videoModelToFormattedDetailsJSON(this) } getFormattedVideoFilesJSON (): VideoFile[] { const { baseUrlHttp, baseUrlWs } = this.getBaseUrls() return videoFilesModelToFormattedJSON(this, baseUrlHttp, baseUrlWs, this.VideoFiles) } toActivityPubObject (this: MVideoAP): VideoTorrentObject { return videoModelToActivityPubObject(this) } getTruncatedDescription () { if (!this.description) return null const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max return peertubeTruncate(this.description, { length: maxLength }) } getMaxQualityResolution () { const file = this.getMaxQualityFile() const videoOrPlaylist = file.getVideoOrStreamingPlaylist() const originalFilePath = getVideoFilePath(videoOrPlaylist, file) return getVideoFileResolution(originalFilePath) } getDescriptionAPIPath () { return `/api/${API_VERSION}/videos/${this.uuid}/description` } getHLSPlaylist (): MStreamingPlaylistFilesVideo { if (!this.VideoStreamingPlaylists) return undefined const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS) playlist.Video = this return playlist } setHLSPlaylist (playlist: MStreamingPlaylist) { const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ] if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) { this.VideoStreamingPlaylists = toAdd return } this.VideoStreamingPlaylists = this.VideoStreamingPlaylists .filter(s => s.type !== VideoStreamingPlaylistType.HLS) .concat(toAdd) } removeFile (videoFile: MVideoFile, isRedundancy = false) { const filePath = getVideoFilePath(this, videoFile, isRedundancy) return remove(filePath) .catch(err => logger.warn('Cannot delete file %s.', filePath, { err })) } removeTorrent (videoFile: MVideoFile) { const torrentPath = getTorrentFilePath(this, videoFile) return remove(torrentPath) .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err })) } async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) { const directoryPath = getHLSDirectory(this, isRedundancy) await remove(directoryPath) if (isRedundancy !== true) { const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo streamingPlaylistWithFiles.Video = this if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) { streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles') } // Remove physical files and torrents await Promise.all( streamingPlaylistWithFiles.VideoFiles.map(file => streamingPlaylistWithFiles.removeTorrent(file)) ) } } isOutdated () { if (this.isOwned()) return false return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL) } hasPrivacyForFederation () { return VideoModel.isPrivacyForFederation(this.privacy) } isNewVideo (newPrivacy: VideoPrivacy) { return this.hasPrivacyForFederation() === false && VideoModel.isPrivacyForFederation(newPrivacy) === true } setAsRefreshed () { this.changed('updatedAt', true) return this.save() } requiresAuth () { return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist } setPrivacy (newPrivacy: VideoPrivacy) { if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) { this.publishedAt = new Date() } this.privacy = newPrivacy } isConfidential () { return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.UNLISTED || this.privacy === VideoPrivacy.INTERNAL } async publishIfNeededAndSave (t: Transaction) { if (this.state !== VideoState.PUBLISHED) { this.state = VideoState.PUBLISHED this.publishedAt = new Date() await this.save({ transaction: t }) return true } return false } getBaseUrls () { if (this.isOwned()) { return { baseUrlHttp: WEBSERVER.URL, baseUrlWs: WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT } } return { baseUrlHttp: REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host, baseUrlWs: REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host } } getTrackerUrls (baseUrlHttp: string, baseUrlWs: string) { return [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ] } getTorrentUrl (videoFile: MVideoFile, baseUrlHttp: string) { return baseUrlHttp + STATIC_PATHS.TORRENTS + getTorrentFileName(this, videoFile) } getTorrentDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) { return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + getTorrentFileName(this, videoFile) } getVideoFileUrl (videoFile: MVideoFile, baseUrlHttp: string) { return baseUrlHttp + STATIC_PATHS.WEBSEED + getVideoFilename(this, videoFile) } getVideoFileMetadataUrl (videoFile: MVideoFile, baseUrlHttp: string) { const path = '/api/v1/videos/' return this.isOwned() ? baseUrlHttp + path + this.uuid + '/metadata/' + videoFile.id : videoFile.metadataUrl } getVideoRedundancyUrl (videoFile: MVideoFile, baseUrlHttp: string) { return baseUrlHttp + STATIC_PATHS.REDUNDANCY + getVideoFilename(this, videoFile) } getVideoFileDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) { return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + getVideoFilename(this, videoFile) } getBandwidthBits (videoFile: MVideoFile) { return Math.ceil((videoFile.size * 8) / this.duration) } }