-import * as Sequelize from 'sequelize'
+import { FindOptions, Includeable, literal, Op, ScopeOptions } from 'sequelize'
import {
- AfterDestroy,
AllowNull,
+ BeforeDestroy,
BelongsTo,
Column,
CreatedAt,
DataType,
Default,
+ DefaultScope,
ForeignKey,
HasMany,
Is,
- IsUUID,
Model,
Scopes,
+ Sequelize,
Table,
UpdatedAt
} from 'sequelize-typescript'
-import { IFindOptions } from 'sequelize-typescript/lib/interfaces/IFindOptions'
-import { isVideoChannelDescriptionValid, isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
-import { sendDeleteVideoChannel } from '../../lib/activitypub/send'
-import { AccountModel } from '../account/account'
-import { ActorModel } from '../activitypub/actor'
+import { MAccountActor } from '@server/types/models'
+import { ActivityPubActor } from '../../../shared/models/activitypub'
+import { VideoChannel, VideoChannelSummary } from '../../../shared/models/videos'
+import {
+ isVideoChannelDescriptionValid,
+ isVideoChannelNameValid,
+ isVideoChannelSupportValid
+} from '../../helpers/custom-validators/video-channels'
+import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
+import { sendDeleteActor } from '../../lib/activitypub/send'
+import {
+ MChannelAccountDefault,
+ MChannelActor,
+ MChannelActorAccountDefaultVideos,
+ MChannelAP,
+ MChannelFormattable,
+ MChannelSummaryFormattable
+} from '../../types/models/video'
+import { AccountModel, ScopeNames as AccountModelScopeNames, SummaryOptions as AccountSummaryOptions } from '../account/account'
+import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
+import { ActorFollowModel } from '../activitypub/actor-follow'
+import { AvatarModel } from '../avatar/avatar'
import { ServerModel } from '../server/server'
-import { getSort, throwIfNotValid } from '../utils'
+import { buildServerIdsFollowedBy, buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
import { VideoModel } from './video'
-import { VideoChannelShareModel } from './video-channel-share'
+import { VideoPlaylistModel } from './video-playlist'
-enum ScopeNames {
+export enum ScopeNames {
+ FOR_API = 'FOR_API',
+ SUMMARY = 'SUMMARY',
WITH_ACCOUNT = 'WITH_ACCOUNT',
- WITH_VIDEOS = 'WITH_VIDEOS'
+ WITH_ACTOR = 'WITH_ACTOR',
+ WITH_VIDEOS = 'WITH_VIDEOS',
+ WITH_STATS = 'WITH_STATS'
+}
+
+type AvailableForListOptions = {
+ actorId: number
+ search?: string
}
-@Scopes({
+type AvailableWithStatsOptions = {
+ daysPrior: number
+}
+
+export type SummaryOptions = {
+ actorRequired?: boolean // Default: true
+ withAccount?: boolean // Default: false
+ withAccountBlockerIds?: number[]
+}
+
+@DefaultScope(() => ({
+ include: [
+ {
+ model: ActorModel,
+ required: true
+ }
+ ]
+}))
+@Scopes(() => ({
+ [ScopeNames.FOR_API]: (options: AvailableForListOptions) => {
+ // Only list local channels OR channels that are on an instance followed by actorId
+ const inQueryInstanceFollow = buildServerIdsFollowedBy(options.actorId)
+
+ return {
+ include: [
+ {
+ attributes: {
+ exclude: unusedActorAttributesForAPI
+ },
+ model: ActorModel,
+ where: {
+ [Op.or]: [
+ {
+ serverId: null
+ },
+ {
+ serverId: {
+ [Op.in]: Sequelize.literal(inQueryInstanceFollow)
+ }
+ }
+ ]
+ }
+ },
+ {
+ model: AccountModel,
+ required: true,
+ include: [
+ {
+ attributes: {
+ exclude: unusedActorAttributesForAPI
+ },
+ model: ActorModel, // Default scope includes avatar and server
+ required: true
+ }
+ ]
+ }
+ ]
+ }
+ },
+ [ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
+ const include: Includeable[] = [
+ {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
+ model: ActorModel.unscoped(),
+ required: options.actorRequired ?? true,
+ include: [
+ {
+ attributes: [ 'host' ],
+ model: ServerModel.unscoped(),
+ required: false
+ },
+ {
+ model: AvatarModel.unscoped(),
+ required: false
+ }
+ ]
+ }
+ ]
+
+ const base: FindOptions = {
+ attributes: [ 'id', 'name', 'description', 'actorId' ]
+ }
+
+ if (options.withAccount === true) {
+ include.push({
+ model: AccountModel.scope({
+ method: [ AccountModelScopeNames.SUMMARY, { withAccountBlockerIds: options.withAccountBlockerIds } as AccountSummaryOptions ]
+ }),
+ required: true
+ })
+ }
+
+ base.include = include
+
+ return base
+ },
[ScopeNames.WITH_ACCOUNT]: {
include: [
{
- model: () => AccountModel,
- include: [ { model: () => ServerModel, required: false } ]
+ model: AccountModel,
+ required: true
}
]
},
+ [ScopeNames.WITH_ACTOR]: {
+ include: [
+ ActorModel
+ ]
+ },
[ScopeNames.WITH_VIDEOS]: {
include: [
- () => VideoModel
+ VideoModel
]
+ },
+ [ScopeNames.WITH_STATS]: (options: AvailableWithStatsOptions = { daysPrior: 30 }) => {
+ const daysPrior = parseInt(options.daysPrior + '', 10)
+
+ return {
+ attributes: {
+ include: [
+ [
+ literal('(SELECT COUNT(*) FROM "video" WHERE "channelId" = "VideoChannelModel"."id")'),
+ 'videosCount'
+ ],
+ [
+ literal(
+ '(' +
+ `SELECT string_agg(concat_ws('|', t.day, t.views), ',') ` +
+ 'FROM ( ' +
+ 'WITH ' +
+ 'days AS ( ' +
+ `SELECT generate_series(date_trunc('day', now()) - '${daysPrior} day'::interval, ` +
+ `date_trunc('day', now()), '1 day'::interval) AS day ` +
+ ') ' +
+ 'SELECT days.day AS day, COALESCE(SUM("videoView".views), 0) AS views ' +
+ 'FROM days ' +
+ 'LEFT JOIN (' +
+ '"videoView" INNER JOIN "video" ON "videoView"."videoId" = "video"."id" ' +
+ 'AND "video"."channelId" = "VideoChannelModel"."id"' +
+ `) ON date_trunc('day', "videoView"."startDate") = date_trunc('day', days.day) ` +
+ 'GROUP BY day ' +
+ 'ORDER BY day ' +
+ ') t' +
+ ')'
+ ),
+ 'viewsPerDay'
+ ]
+ ]
+ }
+ }
}
-})
+}))
@Table({
tableName: 'videoChannel',
indexes: [
+ buildTrigramSearchIndex('video_channel_name_trigram', 'name'),
+
{
fields: [ 'accountId' ]
+ },
+ {
+ fields: [ 'actorId' ]
}
]
})
-export class VideoChannelModel extends Model<VideoChannelModel> {
-
- @AllowNull(false)
- @Default(DataType.UUIDV4)
- @IsUUID(4)
- @Column(DataType.UUID)
- uuid: string
+export class VideoChannelModel extends Model {
@AllowNull(false)
@Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelNameValid, 'name'))
name: string
@AllowNull(true)
- @Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description'))
- @Column
+ @Default(null)
+ @Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.DESCRIPTION.max))
description: string
- @AllowNull(false)
- @Column
- remote: boolean
+ @AllowNull(true)
+ @Default(null)
+ @Is('VideoChannelSupport', value => throwIfNotValid(value, isVideoChannelSupportValid, 'support', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.SUPPORT.max))
+ support: string
@CreatedAt
createdAt: Date
foreignKey: {
allowNull: false
},
- onDelete: 'CASCADE'
+ hooks: true
})
Account: AccountModel
name: 'channelId',
allowNull: false
},
- onDelete: 'CASCADE'
+ onDelete: 'CASCADE',
+ hooks: true
})
Videos: VideoModel[]
- @HasMany(() => VideoChannelShareModel, {
+ @HasMany(() => VideoPlaylistModel, {
foreignKey: {
- name: 'channelId',
- allowNull: false
+ allowNull: true
},
- onDelete: 'CASCADE'
+ onDelete: 'CASCADE',
+ hooks: true
})
- VideoChannelShares: VideoChannelShareModel[]
+ VideoPlaylists: VideoPlaylistModel[]
- @AfterDestroy
- static sendDeleteIfOwned (instance: VideoChannelModel) {
- if (instance.isOwned()) {
- return sendDeleteVideoChannel(instance, undefined)
+ @BeforeDestroy
+ static async sendDeleteIfOwned (instance: VideoChannelModel, options) {
+ if (!instance.Actor) {
+ instance.Actor = await instance.$get('Actor', { transaction: options.transaction })
+ }
+
+ await ActorFollowModel.removeFollowsOf(instance.Actor.id, options.transaction)
+
+ if (instance.Actor.isOwned()) {
+ return sendDeleteActor(instance.Actor, options.transaction)
}
return undefined
return VideoChannelModel.count(query)
}
- static listForApi (start: number, count: number, sort: string) {
+ static listForApi (parameters: {
+ actorId: number
+ start: number
+ count: number
+ sort: string
+ }) {
+ const { actorId } = parameters
+
const query = {
- offset: start,
- limit: count,
- order: [ getSort(sort) ]
+ offset: parameters.start,
+ limit: parameters.count,
+ order: getSort(parameters.sort)
}
- return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findAndCountAll(query)
+ return VideoChannelModel
+ .scope({
+ method: [ ScopeNames.FOR_API, { actorId } as AvailableForListOptions ]
+ })
+ .findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
- static listByAccount (accountId: number) {
+ static listLocalsForSitemap (sort: string): Promise<MChannelActor[]> {
const query = {
- order: [ getSort('createdAt') ],
+ attributes: [ ],
+ offset: 0,
+ order: getSort(sort),
include: [
{
- model: AccountModel,
+ attributes: [ 'preferredUsername', 'serverId' ],
+ model: ActorModel.unscoped(),
where: {
- id: accountId
- },
- required: true,
- include: [ { model: ServerModel, required: false } ]
+ serverId: null
+ }
}
]
}
- return VideoChannelModel.findAndCountAll(query)
+ return VideoChannelModel
+ .unscoped()
+ .findAll(query)
+ }
+
+ static searchForApi (options: {
+ actorId: number
+ search: string
+ start: number
+ count: number
+ sort: string
+ }) {
+ const attributesInclude = []
+ const escapedSearch = VideoModel.sequelize.escape(options.search)
+ const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
+ attributesInclude.push(createSimilarityAttribute('VideoChannelModel.name', options.search))
+
+ const query = {
+ attributes: {
+ include: attributesInclude
+ },
+ offset: options.start,
+ limit: options.count,
+ order: getSort(options.sort),
+ where: {
+ [Op.or]: [
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoChannelModel"."name")) % lower(immutable_unaccent(' + escapedSearch + '))'
+ ),
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoChannelModel"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))'
+ )
+ ]
+ }
+ }
+
+ return VideoChannelModel
+ .scope({
+ method: [ ScopeNames.FOR_API, { actorId: options.actorId } as AvailableForListOptions ]
+ })
+ .findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
- static loadByUrl (url: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
+ static listByAccount (options: {
+ accountId: number
+ start: number
+ count: number
+ sort: string
+ withStats?: boolean
+ search?: string
+ }) {
+ const escapedSearch = VideoModel.sequelize.escape(options.search)
+ const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
+ const where = options.search
+ ? {
+ [Op.or]: [
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoChannelModel"."name")) % lower(immutable_unaccent(' + escapedSearch + '))'
+ ),
+ Sequelize.literal(
+ 'lower(immutable_unaccent("VideoChannelModel"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))'
+ )
+ ]
+ }
+ : null
+
+ const query = {
+ offset: options.start,
+ limit: options.count,
+ order: getSort(options.sort),
include: [
{
- model: ActorModel,
- required: true,
+ model: AccountModel,
where: {
- url
- }
+ id: options.accountId
+ },
+ required: true
}
- ]
+ ],
+ where
}
- if (t !== undefined) query.transaction = t
+ const scopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR ]
- return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(query)
- }
-
- static loadByUUIDOrUrl (uuid: string, url: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- [ Sequelize.Op.or ]: [
- { uuid },
- { url }
- ]
- }
+ if (options.withStats === true) {
+ scopes.push({
+ method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ]
+ })
}
- if (t !== undefined) query.transaction = t
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return { total: count, data: rows }
+ })
+ }
- return VideoChannelModel.findOne(query)
+ static loadByIdAndPopulateAccount (id: number): Promise<MChannelAccountDefault> {
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findByPk(id)
}
- static loadByIdAndAccount (id: number, accountId: number) {
- const options = {
+ static loadByIdAndAccount (id: number, accountId: number): Promise<MChannelAccountDefault> {
+ const query = {
where: {
id,
accountId
}
}
- return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(options)
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadAndPopulateAccount (id: number) {
- return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findById(id)
+ static loadAndPopulateAccount (id: number): Promise<MChannelAccountDefault> {
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findByPk(id)
}
- static loadByUUIDAndPopulateAccount (uuid: string) {
- const options = {
- where: {
- uuid
- }
+ static loadByUrlAndPopulateAccount (url: string): Promise<MChannelAccountDefault> {
+ const query = {
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ url
+ }
+ }
+ ]
+ }
+
+ return VideoChannelModel
+ .scope([ ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
+ }
+
+ static loadByNameWithHostAndPopulateAccount (nameWithHost: string) {
+ const [ name, host ] = nameWithHost.split('@')
+
+ if (!host || host === WEBSERVER.HOST) return VideoChannelModel.loadLocalByNameAndPopulateAccount(name)
+
+ return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host)
+ }
+
+ static loadLocalByNameAndPopulateAccount (name: string): Promise<MChannelAccountDefault> {
+ const query = {
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name,
+ serverId: null
+ }
+ }
+ ]
}
- return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(options)
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadAndPopulateAccountAndVideos (id: number) {
+ static loadByNameAndHostAndPopulateAccount (name: string, host: string): Promise<MChannelAccountDefault> {
+ const query = {
+ include: [
+ {
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name
+ },
+ include: [
+ {
+ model: ServerModel,
+ required: true,
+ where: { host }
+ }
+ ]
+ }
+ ]
+ }
+
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
+ }
+
+ static loadAndPopulateAccountAndVideos (id: number): Promise<MChannelActorAccountDefaultVideos> {
const options = {
include: [
VideoModel
]
}
- return VideoChannelModel.scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEOS ]).findById(id, options)
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEOS ])
+ .findByPk(id, options)
}
- isOwned () {
- return this.remote === false
+ toFormattedSummaryJSON (this: MChannelSummaryFormattable): VideoChannelSummary {
+ const actor = this.Actor.toFormattedSummaryJSON()
+
+ return {
+ id: this.id,
+ name: actor.name,
+ displayName: this.getDisplayName(),
+ url: actor.url,
+ host: actor.host,
+ avatar: actor.avatar
+ }
}
- toFormattedJSON () {
- const json = {
+ toFormattedJSON (this: MChannelFormattable): VideoChannel {
+ const viewsPerDayString = this.get('viewsPerDay') as string
+ const videosCount = this.get('videosCount') as number
+
+ let viewsPerDay: { date: Date, views: number }[]
+
+ if (viewsPerDayString) {
+ viewsPerDay = viewsPerDayString.split(',')
+ .map(v => {
+ const [ dateString, amount ] = v.split('|')
+
+ return {
+ date: new Date(dateString),
+ views: +amount
+ }
+ })
+ }
+
+ const actor = this.Actor.toFormattedJSON()
+ const videoChannel = {
id: this.id,
- uuid: this.uuid,
- name: this.name,
+ displayName: this.getDisplayName(),
description: this.description,
- isLocal: this.isOwned(),
+ support: this.support,
+ isLocal: this.Actor.isOwned(),
createdAt: this.createdAt,
- updatedAt: this.updatedAt
+ updatedAt: this.updatedAt,
+ ownerAccount: undefined,
+ videosCount,
+ viewsPerDay
}
- if (this.Account !== undefined) {
- json[ 'owner' ] = {
- name: this.Account.name,
- uuid: this.Account.uuid
- }
- }
+ if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()
- if (Array.isArray(this.Videos)) {
- json[ 'videos' ] = this.Videos.map(v => v.toFormattedJSON())
- }
+ return Object.assign(actor, videoChannel)
+ }
+
+ toActivityPubObject (this: MChannelAP): ActivityPubActor {
+ const obj = this.Actor.toActivityPubObject(this.name)
+
+ return Object.assign(obj, {
+ summary: this.description,
+ support: this.support,
+ attributedTo: [
+ {
+ type: 'Person' as 'Person',
+ id: this.Account.Actor.url
+ }
+ ]
+ })
+ }
+
+ getLocalUrl (this: MAccountActor | MChannelActor) {
+ return WEBSERVER.URL + `/video-channels/` + this.Actor.preferredUsername
+ }
- return json
+ getDisplayName () {
+ return this.name
}
- toActivityPubObject () {
- return this.Actor.toActivityPubObject(this.name, this.uuid, 'VideoChannel')
+ isOutdated () {
+ return this.Actor.isOutdated()
}
}