+import { join } from 'path'
+import { FindOptions, literal, Op, ScopeOptions, Sequelize, Transaction, WhereOptions } from 'sequelize'
import {
AllowNull,
BelongsTo,
Table,
UpdatedAt
} from 'sequelize-typescript'
+import { buildUUID, uuidToShort } from '@server/helpers/uuid'
+import { MAccountId, MChannelId } from '@server/types/models'
+import { AttributesOnly, buildPlaylistEmbedPath, buildPlaylistWatchPath, pick } from '@shared/core-utils'
+import { ActivityIconObject } from '../../../shared/models/activitypub/objects'
+import { PlaylistObject } from '../../../shared/models/activitypub/objects/playlist-object'
import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
-import { buildServerIdsFollowedBy, buildWhereIdOrUUID, getSort, isOutdated, throwIfNotValid } from '../utils'
+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'
import {
isVideoPlaylistDescriptionValid,
isVideoPlaylistNameValid,
isVideoPlaylistPrivacyValid
} from '../../helpers/custom-validators/video-playlists'
-import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
import {
ACTIVITY_PUB,
CONSTRAINTS_FIELDS,
VIDEO_PLAYLIST_TYPES,
WEBSERVER
} from '../../initializers/constants'
-import { VideoPlaylist } from '../../../shared/models/videos/playlist/video-playlist.model'
-import { AccountModel, ScopeNames as AccountScopeNames, SummaryOptions } from '../account/account'
-import { ScopeNames as VideoChannelScopeNames, VideoChannelModel } from './video-channel'
-import { join } from 'path'
-import { VideoPlaylistElementModel } from './video-playlist-element'
-import { PlaylistObject } from '../../../shared/models/activitypub/objects/playlist-object'
-import { activityPubCollectionPagination } from '../../helpers/activitypub'
-import { VideoPlaylistType } from '../../../shared/models/videos/playlist/video-playlist-type.model'
-import { ThumbnailModel } from './thumbnail'
-import { ActivityIconObject } from '../../../shared/models/activitypub/objects'
-import { FindOptions, literal, Op, ScopeOptions, Transaction, WhereOptions } from 'sequelize'
-import * as Bluebird from 'bluebird'
+import { MThumbnail } from '../../types/models/video/thumbnail'
import {
- MVideoPlaylistAccountThumbnail, MVideoPlaylistAP,
+ MVideoPlaylistAccountThumbnail,
+ MVideoPlaylistAP,
MVideoPlaylistFormattable,
MVideoPlaylistFull,
MVideoPlaylistFullSummary,
MVideoPlaylistIdWithElements
-} from '../../typings/models/video/video-playlist'
-import { MThumbnail } from '../../typings/models/video/thumbnail'
+} from '../../types/models/video/video-playlist'
+import { AccountModel, ScopeNames as AccountScopeNames, SummaryOptions } from '../account/account'
+import { ActorModel } from '../actor/actor'
+import { setAsUpdated } from '../shared'
+import {
+ buildServerIdsFollowedBy,
+ buildTrigramSearchIndex,
+ buildWhereIdOrUUID,
+ createSimilarityAttribute,
+ getPlaylistSort,
+ isOutdated,
+ throwIfNotValid
+} from '../utils'
+import { ThumbnailModel } from './thumbnail'
+import { ScopeNames as VideoChannelScopeNames, VideoChannelModel } from './video-channel'
+import { VideoPlaylistElementModel } from './video-playlist-element'
enum ScopeNames {
AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
}
type AvailableForListOptions = {
- followerActorId: number
+ followerActorId?: number
type?: VideoPlaylistType
accountId?: number
videoChannelId?: number
- privateAndUnlisted?: boolean
+ listMyPlaylists?: boolean
+ search?: string
+ host?: string
+ uuids?: string[]
+ withVideos?: boolean
+}
+
+function getVideoLengthSelect () {
+ return 'SELECT COUNT("id") FROM "videoPlaylistElement" WHERE "videoPlaylistId" = "VideoPlaylistModel"."id"'
}
@Scopes(() => ({
- [ ScopeNames.WITH_THUMBNAIL ]: {
+ [ScopeNames.WITH_THUMBNAIL]: {
include: [
{
model: ThumbnailModel,
}
]
},
- [ ScopeNames.WITH_VIDEOS_LENGTH ]: {
+ [ScopeNames.WITH_VIDEOS_LENGTH]: {
attributes: {
include: [
[
- literal('(SELECT COUNT("id") FROM "videoPlaylistElement" WHERE "videoPlaylistId" = "VideoPlaylistModel"."id")'),
+ literal(`(${getVideoLengthSelect()})`),
'videosLength'
]
]
}
} as FindOptions,
- [ ScopeNames.WITH_ACCOUNT ]: {
+ [ScopeNames.WITH_ACCOUNT]: {
include: [
{
model: AccountModel,
}
]
},
- [ ScopeNames.WITH_ACCOUNT_AND_CHANNEL_SUMMARY ]: {
+ [ScopeNames.WITH_ACCOUNT_AND_CHANNEL_SUMMARY]: {
include: [
{
model: AccountModel.scope(AccountScopeNames.SUMMARY),
}
]
},
- [ ScopeNames.WITH_ACCOUNT_AND_CHANNEL ]: {
+ [ScopeNames.WITH_ACCOUNT_AND_CHANNEL]: {
include: [
{
model: AccountModel,
}
]
},
- [ ScopeNames.AVAILABLE_FOR_LIST ]: (options: AvailableForListOptions) => {
- // Only list local playlists OR playlists that are on an instance followed by actorId
- const inQueryInstanceFollow = buildServerIdsFollowedBy(options.followerActorId)
- const whereActor = {
- [ Op.or ]: [
+ [ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => {
+ const whereAnd: WhereOptions[] = []
+
+ const whereServer = options.host && options.host !== WEBSERVER.HOST
+ ? { host: options.host }
+ : undefined
+
+ let whereActor: WhereOptions = {}
+
+ if (options.host === WEBSERVER.HOST) {
+ whereActor = {
+ [Op.and]: [ { serverId: null } ]
+ }
+ }
+
+ if (options.listMyPlaylists !== true) {
+ whereAnd.push({
+ privacy: VideoPlaylistPrivacy.PUBLIC
+ })
+
+ // Only list local playlists
+ const whereActorOr: WhereOptions[] = [
{
serverId: null
- },
- {
- serverId: {
- [ Op.in ]: literal(inQueryInstanceFollow)
- }
}
]
- }
- const whereAnd: WhereOptions[] = []
+ // … OR playlists that are on an instance followed by actorId
+ if (options.followerActorId) {
+ const inQueryInstanceFollow = buildServerIdsFollowedBy(options.followerActorId)
- if (options.privateAndUnlisted !== true) {
- whereAnd.push({
- privacy: VideoPlaylistPrivacy.PUBLIC
- })
+ whereActorOr.push({
+ serverId: {
+ [Op.in]: literal(inQueryInstanceFollow)
+ }
+ })
+ }
+
+ Object.assign(whereActor, { [Op.or]: whereActorOr })
}
if (options.accountId) {
})
}
- const where = {
- [Op.and]: whereAnd
+ if (options.uuids) {
+ whereAnd.push({
+ uuid: {
+ [Op.in]: options.uuids
+ }
+ })
}
- const accountScope = {
- method: [ AccountScopeNames.SUMMARY, { whereActor } as SummaryOptions ]
+ if (options.withVideos === true) {
+ whereAnd.push(
+ literal(`(${getVideoLengthSelect()}) != 0`)
+ )
+ }
+
+ let attributesInclude: any[] = [ literal('0 as similarity') ]
+
+ if (options.search) {
+ const escapedSearch = VideoPlaylistModel.sequelize.escape(options.search)
+ const escapedLikeSearch = VideoPlaylistModel.sequelize.escape('%' + options.search + '%')
+ attributesInclude = [ createSimilarityAttribute('VideoPlaylistModel.name', options.search) ]
+
+ whereAnd.push({
+ [Op.or]: [
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoPlaylistModel"."name")) % lower(immutable_unaccent(' + escapedSearch + '))'
+ ),
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoPlaylistModel"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))'
+ )
+ ]
+ })
+ }
+
+ const where = {
+ [Op.and]: whereAnd
}
return {
+ attributes: {
+ include: attributesInclude
+ },
where,
include: [
{
- model: AccountModel.scope(accountScope),
+ model: AccountModel.scope({
+ method: [ AccountScopeNames.SUMMARY, { whereActor, whereServer } as SummaryOptions ]
+ }),
required: true
},
{
@Table({
tableName: 'videoPlaylist',
indexes: [
+ buildTrigramSearchIndex('video_playlist_name_trigram', 'name'),
+
{
fields: [ 'ownerAccountId' ]
},
}
]
})
-export class VideoPlaylistModel extends Model<VideoPlaylistModel> {
+export class VideoPlaylistModel extends Model<Partial<AttributesOnly<VideoPlaylistModel>>> {
@CreatedAt
createdAt: Date
@AllowNull(true)
@Is('VideoPlaylistDescription', value => throwIfNotValid(value, isVideoPlaylistDescriptionValid, 'description', true))
- @Column
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_PLAYLISTS.DESCRIPTION.max))
description: string
@AllowNull(false)
})
Thumbnail: ThumbnailModel
- static listForApi (options: {
- followerActorId: number
- start: number,
- count: number,
- sort: string,
- type?: VideoPlaylistType,
- accountId?: number,
- videoChannelId?: number,
- privateAndUnlisted?: boolean
+ static listForApi (options: AvailableForListOptions & {
+ start: number
+ count: number
+ sort: string
}) {
const query = {
offset: options.start,
limit: options.count,
- order: getSort(options.sort)
+ order: getPlaylistSort(options.sort)
}
const scopes: (string | ScopeOptions)[] = [
method: [
ScopeNames.AVAILABLE_FOR_LIST,
{
- type: options.type,
- followerActorId: options.followerActorId,
- accountId: options.accountId,
- videoChannelId: options.videoChannelId,
- privateAndUnlisted: options.privateAndUnlisted
+ ...pick(options, [ 'type', 'followerActorId', 'accountId', 'videoChannelId', 'listMyPlaylists', 'search', 'host', 'uuids' ]),
+
+ withVideos: options.withVideos || false
} as AvailableForListOptions
]
},
})
}
- static listPublicUrlsOfForAP (accountId: number, start: number, count: number) {
+ static searchForApi (options: Pick<AvailableForListOptions, 'followerActorId' | 'search'| 'host'| 'uuids'> & {
+ start: number
+ count: number
+ sort: string
+ }) {
+ return VideoPlaylistModel.listForApi({
+ ...options,
+
+ type: VideoPlaylistType.REGULAR,
+ listMyPlaylists: false,
+ withVideos: true
+ })
+ }
+
+ 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 })
+ }
+
const query = {
attributes: [ 'url' ],
offset: start,
limit: count,
- where: {
- ownerAccountId: accountId,
- privacy: VideoPlaylistPrivacy.PUBLIC
- }
+ where
}
return VideoPlaylistModel.findAndCountAll(query)
})
}
- static listPlaylistIdsOf (accountId: number, videoIds: number[]): Bluebird<MVideoPlaylistIdWithElements[]> {
+ static listPlaylistIdsOf (accountId: number, videoIds: number[]): Promise<MVideoPlaylistIdWithElements[]> {
const query = {
attributes: [ 'id' ],
where: {
model: VideoPlaylistElementModel.unscoped(),
where: {
videoId: {
- [Op.in]: videoIds // FIXME: sequelize ANY seems broken
+ [Op.in]: videoIds
}
},
required: true
static doesPlaylistExist (url: string) {
const query = {
- attributes: [],
+ attributes: [ 'id' ],
where: {
url
}
.then(e => !!e)
}
- static loadWithAccountAndChannelSummary (id: number | string, transaction: Transaction): Bluebird<MVideoPlaylistFullSummary> {
+ static loadWithAccountAndChannelSummary (id: number | string, transaction: Transaction): Promise<MVideoPlaylistFullSummary> {
const where = buildWhereIdOrUUID(id)
const query = {
.findOne(query)
}
- static loadWithAccountAndChannel (id: number | string, transaction: Transaction): Bluebird<MVideoPlaylistFull> {
+ static loadWithAccountAndChannel (id: number | string, transaction: Transaction): Promise<MVideoPlaylistFull> {
const where = buildWhereIdOrUUID(id)
const query = {
.findOne(query)
}
- static loadByUrlAndPopulateAccount (url: string): Bluebird<MVideoPlaylistAccountThumbnail> {
+ static loadByUrlAndPopulateAccount (url: string): Promise<MVideoPlaylistAccountThumbnail> {
const query = {
where: {
url
return VideoPlaylistModel.scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_THUMBNAIL ]).findOne(query)
}
+ static loadByUrlWithAccountAndChannelSummary (url: string): Promise<MVideoPlaylistFullSummary> {
+ const query = {
+ where: {
+ url
+ }
+ }
+
+ return VideoPlaylistModel
+ .scope([ ScopeNames.WITH_ACCOUNT_AND_CHANNEL_SUMMARY, ScopeNames.WITH_VIDEOS_LENGTH, ScopeNames.WITH_THUMBNAIL ])
+ .findOne(query)
+ }
+
static getPrivacyLabel (privacy: VideoPlaylistPrivacy) {
return VIDEO_PLAYLIST_PRIVACIES[privacy] || 'Unknown'
}
generateThumbnailName () {
const extension = '.jpg'
- return 'playlist-' + this.uuid + extension
+ return 'playlist-' + buildUUID() + extension
}
getThumbnailUrl () {
return join(STATIC_PATHS.THUMBNAILS, this.Thumbnail.filename)
}
+ getWatchStaticPath () {
+ return buildPlaylistWatchPath({ shortUUID: uuidToShort(this.uuid) })
+ }
+
+ getEmbedStaticPath () {
+ return buildPlaylistEmbedPath(this)
+ }
+
+ 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
+ }
+ }
+
setAsRefreshed () {
- this.changed('updatedAt', true)
+ return setAsUpdated('videoPlaylist', this.id)
+ }
- return this.save()
+ setVideosLength (videosLength: number) {
+ this.set('videosLength' as any, videosLength, { raw: true })
}
isOwned () {
return {
id: this.id,
uuid: this.uuid,
+ shortUUID: uuidToShort(this.uuid),
+
isLocal: this.isOwned(),
+ url: this.url,
+
displayName: this.name,
description: this.description,
privacy: {
},
thumbnailPath: this.getThumbnailStaticPath(),
+ embedPath: this.getEmbedStaticPath(),
type: {
id: this.type,
updatedAt: this.updatedAt,
ownerAccount: this.OwnerAccount.toFormattedSummaryJSON(),
- videoChannel: this.VideoChannel ? this.VideoChannel.toFormattedSummaryJSON() : null
+ videoChannel: this.VideoChannel
+ ? this.VideoChannel.toFormattedSummaryJSON()
+ : null
}
}