PeerTube/server/models/video/video-playlist.ts

613 lines
15 KiB
TypeScript
Raw Normal View History

2020-12-02 10:07:26 +01:00
import { join } from 'path'
import { FindOptions, literal, Op, ScopeOptions, Transaction, WhereOptions } from 'sequelize'
2019-02-26 10:55:40 +01:00
import {
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
Default,
ForeignKey,
HasMany,
HasOne,
2019-02-26 10:55:40 +01:00
Is,
IsUUID,
Model,
Scopes,
Table,
2019-12-27 09:04:04 +01:00
UpdatedAt
2019-02-26 10:55:40 +01:00
} from 'sequelize-typescript'
2021-02-16 08:50:40 +01:00
import { v4 as uuidv4 } from 'uuid'
2020-12-02 10:07:26 +01:00
import { MAccountId, MChannelId } from '@server/types/models'
2021-05-12 14:09:04 +02:00
import { AttributesOnly } from '@shared/core-utils'
2020-12-02 10:07:26 +01:00
import { ActivityIconObject } from '../../../shared/models/activitypub/objects'
import { PlaylistObject } from '../../../shared/models/activitypub/objects/playlist-object'
2019-02-26 10:55:40 +01:00
import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
2020-12-02 10:07:26 +01:00
import { VideoPlaylistType } from '../../../shared/models/videos/playlist/video-playlist-type.model'
import { VideoPlaylist } from '../../../shared/models/videos/playlist/video-playlist.model'
import { activityPubCollectionPagination } from '../../helpers/activitypub'
import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
2019-02-26 10:55:40 +01:00
import {
isVideoPlaylistDescriptionValid,
isVideoPlaylistNameValid,
isVideoPlaylistPrivacyValid
} from '../../helpers/custom-validators/video-playlists'
2019-03-05 10:58:44 +01:00
import {
2019-03-19 14:13:53 +01:00
ACTIVITY_PUB,
2019-03-05 10:58:44 +01:00
CONSTRAINTS_FIELDS,
STATIC_PATHS,
THUMBNAILS_SIZE,
VIDEO_PLAYLIST_PRIVACIES,
2019-04-11 11:33:44 +02:00
VIDEO_PLAYLIST_TYPES,
WEBSERVER
} from '../../initializers/constants'
2020-12-02 10:07:26 +01:00
import { MThumbnail } from '../../types/models/video/thumbnail'
2019-08-15 11:53:26 +02:00
import {
2019-12-27 09:04:04 +01:00
MVideoPlaylistAccountThumbnail,
MVideoPlaylistAP,
2019-08-20 19:05:31 +02:00
MVideoPlaylistFormattable,
2019-08-15 11:53:26 +02:00
MVideoPlaylistFull,
MVideoPlaylistFullSummary,
MVideoPlaylistIdWithElements
2020-06-18 10:45:25 +02:00
} from '../../types/models/video/video-playlist'
2020-12-02 10:07:26 +01:00
import { AccountModel, ScopeNames as AccountScopeNames, SummaryOptions } from '../account/account'
2021-05-11 11:15:29 +02:00
import { ActorModel } from '../actor/actor'
2020-12-02 10:07:26 +01:00
import { buildServerIdsFollowedBy, buildWhereIdOrUUID, getPlaylistSort, isOutdated, throwIfNotValid } from '../utils'
import { ThumbnailModel } from './thumbnail'
import { ScopeNames as VideoChannelScopeNames, VideoChannelModel } from './video-channel'
import { VideoPlaylistElementModel } from './video-playlist-element'
2019-02-26 10:55:40 +01:00
enum ScopeNames {
AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
WITH_VIDEOS_LENGTH = 'WITH_VIDEOS_LENGTH',
2019-03-05 10:58:44 +01:00
WITH_ACCOUNT_AND_CHANNEL_SUMMARY = 'WITH_ACCOUNT_AND_CHANNEL_SUMMARY',
2019-03-05 11:30:43 +01:00
WITH_ACCOUNT = 'WITH_ACCOUNT',
WITH_THUMBNAIL = 'WITH_THUMBNAIL',
2019-03-05 11:30:43 +01:00
WITH_ACCOUNT_AND_CHANNEL = 'WITH_ACCOUNT_AND_CHANNEL'
2019-02-26 10:55:40 +01:00
}
type AvailableForListOptions = {
followerActorId?: number
2019-03-05 10:58:44 +01:00
type?: VideoPlaylistType
accountId?: number
2019-02-26 10:55:40 +01:00
videoChannelId?: number
2020-01-31 16:56:52 +01:00
listMyPlaylists?: boolean
search?: string
2019-02-26 10:55:40 +01:00
}
2019-04-23 09:50:57 +02:00
@Scopes(() => ({
2020-01-31 16:56:52 +01:00
[ScopeNames.WITH_THUMBNAIL]: {
include: [
{
2019-04-23 09:50:57 +02:00
model: ThumbnailModel,
required: false
}
]
},
2020-01-31 16:56:52 +01:00
[ScopeNames.WITH_VIDEOS_LENGTH]: {
2019-02-26 10:55:40 +01:00
attributes: {
include: [
2019-04-18 11:28:17 +02:00
[
literal('(SELECT COUNT("id") FROM "videoPlaylistElement" WHERE "videoPlaylistId" = "VideoPlaylistModel"."id")'),
2019-02-26 10:55:40 +01:00
'videosLength'
]
]
}
2019-04-23 09:50:57 +02:00
} as FindOptions,
2020-01-31 16:56:52 +01:00
[ScopeNames.WITH_ACCOUNT]: {
2019-03-05 10:58:44 +01:00
include: [
{
2019-04-23 09:50:57 +02:00
model: AccountModel,
2019-03-05 10:58:44 +01:00
required: true
}
]
},
2020-01-31 16:56:52 +01:00
[ScopeNames.WITH_ACCOUNT_AND_CHANNEL_SUMMARY]: {
2019-02-26 10:55:40 +01:00
include: [
{
2019-04-23 09:50:57 +02:00
model: AccountModel.scope(AccountScopeNames.SUMMARY),
2019-02-26 10:55:40 +01:00
required: true
},
{
2019-04-23 09:50:57 +02:00
model: VideoChannelModel.scope(VideoChannelScopeNames.SUMMARY),
2019-02-26 10:55:40 +01:00
required: false
}
]
},
2020-01-31 16:56:52 +01:00
[ScopeNames.WITH_ACCOUNT_AND_CHANNEL]: {
2019-03-05 11:30:43 +01:00
include: [
{
2019-04-23 09:50:57 +02:00
model: AccountModel,
2019-03-05 11:30:43 +01:00
required: true
},
{
2019-04-23 09:50:57 +02:00
model: VideoChannelModel,
2019-03-05 11:30:43 +01:00
required: false
}
]
},
2020-01-31 16:56:52 +01:00
[ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => {
2020-01-09 09:26:59 +01:00
let whereActor: WhereOptions = {}
2019-02-26 10:55:40 +01:00
2019-04-23 09:50:57 +02:00
const whereAnd: WhereOptions[] = []
2019-02-26 10:55:40 +01:00
2020-01-09 09:26:59 +01:00
if (options.listMyPlaylists !== true) {
2019-02-26 10:55:40 +01:00
whereAnd.push({
privacy: VideoPlaylistPrivacy.PUBLIC
})
2020-01-09 09:26:59 +01:00
// Only list local playlists
const whereActorOr: WhereOptions[] = [
{
serverId: null
}
]
2020-01-09 09:26:59 +01:00
// … OR playlists that are on an instance followed by actorId
if (options.followerActorId) {
const inQueryInstanceFollow = buildServerIdsFollowedBy(options.followerActorId)
whereActorOr.push({
serverId: {
[Op.in]: literal(inQueryInstanceFollow)
2020-01-09 09:26:59 +01:00
}
})
}
whereActor = {
[Op.or]: whereActorOr
2020-01-09 09:26:59 +01:00
}
2019-02-26 10:55:40 +01:00
}
if (options.accountId) {
whereAnd.push({
ownerAccountId: options.accountId
})
}
if (options.videoChannelId) {
whereAnd.push({
videoChannelId: options.videoChannelId
})
}
2019-03-05 10:58:44 +01:00
if (options.type) {
whereAnd.push({
type: options.type
})
}
if (options.search) {
whereAnd.push({
2019-12-27 09:04:04 +01:00
name: {
2020-01-31 16:56:52 +01:00
[Op.iLike]: '%' + options.search + '%'
}
})
}
2019-02-26 10:55:40 +01:00
const where = {
2019-04-18 11:28:17 +02:00
[Op.and]: whereAnd
2019-02-26 10:55:40 +01:00
}
return {
where,
include: [
{
2020-12-08 14:30:29 +01:00
model: AccountModel.scope({
method: [ AccountScopeNames.SUMMARY, { whereActor } as SummaryOptions ]
}),
2019-02-26 10:55:40 +01:00
required: true
},
{
model: VideoChannelModel.scope(VideoChannelScopeNames.SUMMARY),
required: false
}
]
2019-04-23 09:50:57 +02:00
} as FindOptions
2019-02-26 10:55:40 +01:00
}
2019-04-23 09:50:57 +02:00
}))
2019-02-26 10:55:40 +01:00
@Table({
tableName: 'videoPlaylist',
indexes: [
{
fields: [ 'ownerAccountId' ]
},
{
fields: [ 'videoChannelId' ]
},
{
fields: [ 'url' ],
unique: true
}
]
})
2021-05-12 14:09:04 +02:00
export class VideoPlaylistModel extends Model<Partial<AttributesOnly<VideoPlaylistModel>>> {
2019-02-26 10:55:40 +01:00
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@AllowNull(false)
@Is('VideoPlaylistName', value => throwIfNotValid(value, isVideoPlaylistNameValid, 'name'))
@Column
name: string
@AllowNull(true)
2019-04-18 11:28:17 +02:00
@Is('VideoPlaylistDescription', value => throwIfNotValid(value, isVideoPlaylistDescriptionValid, 'description', true))
2020-05-05 16:27:46 +02:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.DESCRIPTION.max))
2019-02-26 10:55:40 +01:00
description: string
@AllowNull(false)
@Is('VideoPlaylistPrivacy', value => throwIfNotValid(value, isVideoPlaylistPrivacyValid, 'privacy'))
@Column
privacy: VideoPlaylistPrivacy
@AllowNull(false)
@Is('VideoPlaylistUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.URL.max))
url: string
@AllowNull(false)
@Default(DataType.UUIDV4)
@IsUUID(4)
@Column(DataType.UUID)
uuid: string
2019-03-05 10:58:44 +01:00
@AllowNull(false)
@Default(VideoPlaylistType.REGULAR)
@Column
type: VideoPlaylistType
2019-02-26 10:55:40 +01:00
@ForeignKey(() => AccountModel)
@Column
ownerAccountId: number
@BelongsTo(() => AccountModel, {
foreignKey: {
allowNull: false
},
onDelete: 'CASCADE'
})
OwnerAccount: AccountModel
@ForeignKey(() => VideoChannelModel)
@Column
videoChannelId: number
@BelongsTo(() => VideoChannelModel, {
foreignKey: {
2019-02-28 11:14:26 +01:00
allowNull: true
2019-02-26 10:55:40 +01:00
},
onDelete: 'CASCADE'
})
VideoChannel: VideoChannelModel
@HasMany(() => VideoPlaylistElementModel, {
foreignKey: {
name: 'videoPlaylistId',
allowNull: false
},
2019-03-05 10:58:44 +01:00
onDelete: 'CASCADE'
2019-02-26 10:55:40 +01:00
})
VideoPlaylistElements: VideoPlaylistElementModel[]
@HasOne(() => ThumbnailModel, {
foreignKey: {
name: 'videoPlaylistId',
allowNull: true
},
onDelete: 'CASCADE',
hooks: true
})
Thumbnail: ThumbnailModel
2019-02-26 10:55:40 +01:00
static listForApi (options: {
followerActorId: number
2020-01-31 16:56:52 +01:00
start: number
count: number
sort: string
type?: VideoPlaylistType
accountId?: number
videoChannelId?: number
listMyPlaylists?: boolean
search?: string
2019-02-26 10:55:40 +01:00
}) {
const query = {
offset: options.start,
limit: options.count,
order: getPlaylistSort(options.sort)
2019-02-26 10:55:40 +01:00
}
2019-04-23 09:50:57 +02:00
const scopes: (string | ScopeOptions)[] = [
2019-02-26 10:55:40 +01:00
{
method: [
ScopeNames.AVAILABLE_FOR_LIST,
{
2019-03-05 10:58:44 +01:00
type: options.type,
2019-02-26 10:55:40 +01:00
followerActorId: options.followerActorId,
accountId: options.accountId,
videoChannelId: options.videoChannelId,
2020-01-09 09:26:59 +01:00
listMyPlaylists: options.listMyPlaylists,
search: options.search
2019-02-26 10:55:40 +01:00
} as AvailableForListOptions
]
2019-04-23 09:50:57 +02:00
},
ScopeNames.WITH_VIDEOS_LENGTH,
ScopeNames.WITH_THUMBNAIL
2019-02-26 10:55:40 +01:00
]
return VideoPlaylistModel
.scope(scopes)
.findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
static listPublicUrlsOfForAP (options: { account?: MAccountId, channel?: MChannelId }, start: number, count: number) {
const where = {
privacy: VideoPlaylistPrivacy.PUBLIC
}
if (options.account) {
Object.assign(where, { ownerAccountId: options.account.id })
}
if (options.channel) {
Object.assign(where, { videoChannelId: options.channel.id })
}
2019-02-26 10:55:40 +01:00
const query = {
attributes: [ 'url' ],
offset: start,
limit: count,
where
2019-02-26 10:55:40 +01:00
}
return VideoPlaylistModel.findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows.map(p => p.url) }
})
}
2020-12-08 14:30:29 +01:00
static listPlaylistIdsOf (accountId: number, videoIds: number[]): Promise<MVideoPlaylistIdWithElements[]> {
2019-03-07 17:06:00 +01:00
const query = {
attributes: [ 'id' ],
where: {
ownerAccountId: accountId
},
include: [
{
2019-07-31 15:57:32 +02:00
attributes: [ 'id', 'videoId', 'startTimestamp', 'stopTimestamp' ],
2019-03-07 17:06:00 +01:00
model: VideoPlaylistElementModel.unscoped(),
where: {
videoId: {
2020-01-28 14:45:17 +01:00
[Op.in]: videoIds
2019-03-07 17:06:00 +01:00
}
},
required: true
}
]
}
return VideoPlaylistModel.findAll(query)
}
2019-02-26 10:55:40 +01:00
static doesPlaylistExist (url: string) {
const query = {
2020-12-08 14:30:29 +01:00
attributes: [ 'id' ],
2019-02-26 10:55:40 +01:00
where: {
url
}
}
return VideoPlaylistModel
.findOne(query)
.then(e => !!e)
}
2020-12-08 14:30:29 +01:00
static loadWithAccountAndChannelSummary (id: number | string, transaction: Transaction): Promise<MVideoPlaylistFullSummary> {
2019-02-26 10:55:40 +01:00
const where = buildWhereIdOrUUID(id)
const query = {
where,
transaction
}
return VideoPlaylistModel
.scope([ ScopeNames.WITH_ACCOUNT_AND_CHANNEL_SUMMARY, ScopeNames.WITH_VIDEOS_LENGTH, ScopeNames.WITH_THUMBNAIL ])
2019-03-05 11:30:43 +01:00
.findOne(query)
}
2020-12-08 14:30:29 +01:00
static loadWithAccountAndChannel (id: number | string, transaction: Transaction): Promise<MVideoPlaylistFull> {
2019-03-05 11:30:43 +01:00
const where = buildWhereIdOrUUID(id)
const query = {
where,
transaction
}
return VideoPlaylistModel
.scope([ ScopeNames.WITH_ACCOUNT_AND_CHANNEL, ScopeNames.WITH_VIDEOS_LENGTH, ScopeNames.WITH_THUMBNAIL ])
2019-02-26 10:55:40 +01:00
.findOne(query)
}
2020-12-08 14:30:29 +01:00
static loadByUrlAndPopulateAccount (url: string): Promise<MVideoPlaylistAccountThumbnail> {
2019-03-05 10:58:44 +01:00
const query = {
where: {
url
}
}
return VideoPlaylistModel.scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_THUMBNAIL ]).findOne(query)
2019-03-05 10:58:44 +01:00
}
2019-02-26 10:55:40 +01:00
static getPrivacyLabel (privacy: VideoPlaylistPrivacy) {
return VIDEO_PLAYLIST_PRIVACIES[privacy] || 'Unknown'
}
2019-03-05 10:58:44 +01:00
static getTypeLabel (type: VideoPlaylistType) {
return VIDEO_PLAYLIST_TYPES[type] || 'Unknown'
}
2019-04-18 11:28:17 +02:00
static resetPlaylistsOfChannel (videoChannelId: number, transaction: Transaction) {
2019-03-05 10:58:44 +01:00
const query = {
where: {
videoChannelId
},
transaction
}
return VideoPlaylistModel.update({ privacy: VideoPlaylistPrivacy.PRIVATE, videoChannelId: null }, query)
}
2019-08-15 11:53:26 +02:00
async setAndSaveThumbnail (thumbnail: MThumbnail, t: Transaction) {
2019-04-23 09:50:57 +02:00
thumbnail.videoPlaylistId = this.id
2019-04-23 09:50:57 +02:00
this.Thumbnail = await thumbnail.save({ transaction: t })
}
hasThumbnail () {
return !!this.Thumbnail
}
hasGeneratedThumbnail () {
return this.hasThumbnail() && this.Thumbnail.automaticallyGenerated === true
}
generateThumbnailName () {
2019-02-26 10:55:40 +01:00
const extension = '.jpg'
2021-02-15 14:08:16 +01:00
return 'playlist-' + uuidv4() + extension
2019-02-26 10:55:40 +01:00
}
getThumbnailUrl () {
if (!this.hasThumbnail()) return null
2019-04-23 09:50:57 +02:00
return WEBSERVER.URL + STATIC_PATHS.THUMBNAILS + this.Thumbnail.filename
2019-02-26 10:55:40 +01:00
}
getThumbnailStaticPath () {
if (!this.hasThumbnail()) return null
2019-02-26 10:55:40 +01:00
2019-04-23 09:50:57 +02:00
return join(STATIC_PATHS.THUMBNAILS, this.Thumbnail.filename)
2019-02-26 10:55:40 +01:00
}
getWatchUrl () {
return WEBSERVER.URL + '/videos/watch/playlist/' + this.uuid
}
2020-08-05 15:35:58 +02:00
getEmbedStaticPath () {
return '/video-playlists/embed/' + this.uuid
}
static async getStats () {
const totalLocalPlaylists = await VideoPlaylistModel.count({
include: [
{
model: AccountModel,
required: true,
include: [
{
model: ActorModel,
required: true,
where: {
serverId: null
}
}
]
}
],
where: {
privacy: VideoPlaylistPrivacy.PUBLIC
}
})
return {
totalLocalPlaylists
}
}
2019-03-19 14:13:53 +01:00
setAsRefreshed () {
this.changed('updatedAt', true)
return this.save()
}
2019-02-26 10:55:40 +01:00
isOwned () {
return this.OwnerAccount.isOwned()
}
2019-03-19 14:13:53 +01:00
isOutdated () {
if (this.isOwned()) return false
return isOutdated(this, ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL)
}
2019-08-20 19:05:31 +02:00
toFormattedJSON (this: MVideoPlaylistFormattable): VideoPlaylist {
2019-02-26 10:55:40 +01:00
return {
id: this.id,
uuid: this.uuid,
isLocal: this.isOwned(),
displayName: this.name,
description: this.description,
privacy: {
id: this.privacy,
label: VideoPlaylistModel.getPrivacyLabel(this.privacy)
},
thumbnailPath: this.getThumbnailStaticPath(),
embedPath: this.getEmbedStaticPath(),
2019-02-26 10:55:40 +01:00
2019-03-05 10:58:44 +01:00
type: {
id: this.type,
label: VideoPlaylistModel.getTypeLabel(this.type)
},
2019-04-18 11:28:17 +02:00
videosLength: this.get('videosLength') as number,
2019-02-26 10:55:40 +01:00
createdAt: this.createdAt,
updatedAt: this.updatedAt,
ownerAccount: this.OwnerAccount.toFormattedSummaryJSON(),
2020-04-21 15:04:39 +02:00
videoChannel: this.VideoChannel
? this.VideoChannel.toFormattedSummaryJSON()
: null
2019-02-26 10:55:40 +01:00
}
}
2019-08-21 14:31:57 +02:00
toActivityPubObject (this: MVideoPlaylistAP, page: number, t: Transaction): Promise<PlaylistObject> {
2019-02-26 10:55:40 +01:00
const handler = (start: number, count: number) => {
2019-03-05 10:58:44 +01:00
return VideoPlaylistElementModel.listUrlsOfForAP(this.id, start, count, t)
2019-02-26 10:55:40 +01:00
}
let icon: ActivityIconObject
if (this.hasThumbnail()) {
icon = {
type: 'Image' as 'Image',
url: this.getThumbnailUrl(),
mediaType: 'image/jpeg' as 'image/jpeg',
width: THUMBNAILS_SIZE.width,
height: THUMBNAILS_SIZE.height
}
}
2019-03-05 10:58:44 +01:00
return activityPubCollectionPagination(this.url, handler, page)
2019-02-26 10:55:40 +01:00
.then(o => {
return Object.assign(o, {
type: 'Playlist' as 'Playlist',
name: this.name,
content: this.description,
uuid: this.uuid,
2019-03-05 10:58:44 +01:00
published: this.createdAt.toISOString(),
updated: this.updatedAt.toISOString(),
2019-02-26 10:55:40 +01:00
attributedTo: this.VideoChannel ? [ this.VideoChannel.Actor.url ] : [],
icon
2019-02-26 10:55:40 +01:00
})
})
}
}