1 import { AggregateOptions, Op, ScopeOptions, Sequelize, Transaction } from 'sequelize'
16 } from 'sequelize-typescript'
17 import validator from 'validator'
18 import { MUserAccountId } from '@server/types/models'
20 MVideoPlaylistElement,
21 MVideoPlaylistElementAP,
22 MVideoPlaylistElementFormattable,
23 MVideoPlaylistElementVideoUrlPlaylistPrivacy,
24 MVideoPlaylistVideoThumbnail
25 } from '@server/types/models/video/video-playlist-element'
26 import { PlaylistElementObject } from '../../../shared/models/activitypub/objects/playlist-element-object'
27 import { VideoPrivacy } from '../../../shared/models/videos'
28 import { VideoPlaylistElement, VideoPlaylistElementType } from '../../../shared/models/videos/playlist/video-playlist-element.model'
29 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
30 import { CONSTRAINTS_FIELDS } from '../../initializers/constants'
31 import { AccountModel } from '../account/account'
32 import { getSort, throwIfNotValid } from '../utils'
33 import { ForAPIOptions, ScopeNames as VideoScopeNames, VideoModel } from './video'
34 import { VideoPlaylistModel } from './video-playlist'
37 tableName: 'videoPlaylistElement',
40 fields: [ 'videoPlaylistId' ]
51 export class VideoPlaylistElementModel extends Model {
59 @Is('VideoPlaylistUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url', true))
60 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.URL.max))
74 startTimestamp: number
82 @ForeignKey(() => VideoPlaylistModel)
84 videoPlaylistId: number
86 @BelongsTo(() => VideoPlaylistModel, {
92 VideoPlaylist: VideoPlaylistModel
94 @ForeignKey(() => VideoModel)
98 @BelongsTo(() => VideoModel, {
106 static deleteAllOf (videoPlaylistId: number, transaction?: Transaction) {
114 return VideoPlaylistElementModel.destroy(query)
117 static listForApi (options: {
120 videoPlaylistId: number
121 serverAccount: AccountModel
122 user?: MUserAccountId
124 const accountIds = [ options.serverAccount.id ]
125 const videoScope: (ScopeOptions | string)[] = [
126 VideoScopeNames.WITH_BLACKLISTED
130 accountIds.push(options.user.Account.id)
131 videoScope.push({ method: [ VideoScopeNames.WITH_USER_HISTORY, options.user.id ] })
134 const forApiOptions: ForAPIOptions = { withAccountBlockerIds: accountIds }
137 VideoScopeNames.FOR_API, forApiOptions
142 offset: options.start,
143 limit: options.count,
144 order: getSort('position'),
146 videoPlaylistId: options.videoPlaylistId
150 model: VideoModel.scope(videoScope),
158 videoPlaylistId: options.videoPlaylistId
163 VideoPlaylistElementModel.count(countQuery),
164 VideoPlaylistElementModel.findAll(findQuery)
165 ]).then(([ total, data ]) => ({ total, data }))
168 static loadByPlaylistAndVideo (videoPlaylistId: number, videoId: number): Promise<MVideoPlaylistElement> {
176 return VideoPlaylistElementModel.findOne(query)
179 static loadById (playlistElementId: number | string): Promise<MVideoPlaylistElement> {
180 return VideoPlaylistElementModel.findByPk(playlistElementId)
183 static loadByPlaylistAndElementIdForAP (
184 playlistId: number | string,
185 playlistElementId: number
186 ): Promise<MVideoPlaylistElementVideoUrlPlaylistPrivacy> {
187 const playlistWhere = validator.isUUID('' + playlistId) ? { uuid: playlistId } : { id: playlistId }
192 attributes: [ 'privacy' ],
193 model: VideoPlaylistModel.unscoped(),
197 attributes: [ 'url' ],
198 model: VideoModel.unscoped()
202 id: playlistElementId
206 return VideoPlaylistElementModel.findOne(query)
209 static listUrlsOfForAP (videoPlaylistId: number, start: number, count: number, t?: Transaction) {
211 attributes: [ 'url' ],
214 order: getSort('position'),
221 return VideoPlaylistElementModel
222 .findAndCountAll(query)
223 .then(({ rows, count }) => {
224 return { total: count, data: rows.map(e => e.url) }
228 static loadFirstElementWithVideoThumbnail (videoPlaylistId: number): Promise<MVideoPlaylistVideoThumbnail> {
230 order: getSort('position'),
236 model: VideoModel.scope(VideoScopeNames.WITH_THUMBNAILS),
242 return VideoPlaylistElementModel
246 static getNextPositionOf (videoPlaylistId: number, transaction?: Transaction) {
247 const query: AggregateOptions<number> = {
254 return VideoPlaylistElementModel.max('position', query)
255 .then(position => position ? position + 1 : 1)
258 static reassignPositionOf (
259 videoPlaylistId: number,
260 firstPosition: number,
263 transaction?: Transaction
269 [Op.gte]: firstPosition,
270 [Op.lte]: endPosition
274 validate: false // We use a literal to update the position
277 return VideoPlaylistElementModel.update({ position: Sequelize.literal(`${newPosition} + "position" - ${firstPosition}`) }, query)
280 static increasePositionOf (
281 videoPlaylistId: number,
282 fromPosition: number,
285 transaction?: Transaction
291 [Op.gte]: fromPosition
297 return VideoPlaylistElementModel.increment({ position: by }, query)
300 getType (this: MVideoPlaylistElementFormattable, displayNSFW?: boolean, accountId?: number) {
301 const video = this.Video
303 if (!video) return VideoPlaylistElementType.DELETED
305 // Owned video, don't filter it
306 if (accountId && video.VideoChannel.Account.id === accountId) return VideoPlaylistElementType.REGULAR
309 if (video.privacy === VideoPrivacy.INTERNAL && accountId) return VideoPlaylistElementType.REGULAR
311 if (video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL) return VideoPlaylistElementType.PRIVATE
313 if (video.isBlacklisted() || video.isBlocked()) return VideoPlaylistElementType.UNAVAILABLE
314 if (video.nsfw === true && displayNSFW === false) return VideoPlaylistElementType.UNAVAILABLE
316 return VideoPlaylistElementType.REGULAR
319 getVideoElement (this: MVideoPlaylistElementFormattable, displayNSFW?: boolean, accountId?: number) {
320 if (!this.Video) return null
321 if (this.getType(displayNSFW, accountId) !== VideoPlaylistElementType.REGULAR) return null
323 return this.Video.toFormattedJSON()
327 this: MVideoPlaylistElementFormattable,
328 options: { displayNSFW?: boolean, accountId?: number } = {}
329 ): VideoPlaylistElement {
332 position: this.position,
333 startTimestamp: this.startTimestamp,
334 stopTimestamp: this.stopTimestamp,
336 type: this.getType(options.displayNSFW, options.accountId),
338 video: this.getVideoElement(options.displayNSFW, options.accountId)
342 toActivityPubObject (this: MVideoPlaylistElementAP): PlaylistElementObject {
343 const base: PlaylistElementObject = {
345 type: 'PlaylistElement',
348 position: this.position
351 if (this.startTimestamp) base.startTimestamp = this.startTimestamp
352 if (this.stopTimestamp) base.stopTimestamp = this.stopTimestamp