-import * as Sequelize 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 { activityPubCollection } from '../../helpers'
-import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub'
-import { isVideoChannelDescriptionValid, isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
-import { CONSTRAINTS_FIELDS } from '../../initializers'
-import { getAnnounceActivityPubUrl } from '../../lib/activitypub'
-import { sendDeleteVideoChannel } from '../../lib/activitypub/send'
-import { AccountModel } from '../account/account'
-import { ServerModel } from '../server/server'
-import { getSort, throwIfNotValid } from '../utils'
+import { ActivityPubActor } from '../../../shared/models/activitypub'
+import { VideoChannel, VideoChannelSummary } from '../../../shared/models/videos'
+import {
+ isVideoChannelDescriptionValid,
+ isVideoChannelNameValid,
+ isVideoChannelSupportValid
+} from '../../helpers/custom-validators/video-channels'
+import { sendDeleteActor } from '../../lib/activitypub/send'
+import { AccountModel, ScopeNames as AccountModelScopeNames, SummaryOptions as AccountSummaryOptions } from '../account/account'
+import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
+import { buildServerIdsFollowedBy, buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
import { VideoModel } from './video'
-import { VideoChannelShareModel } from './video-channel-share'
+import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
+import { ServerModel } from '../server/server'
+import { FindOptions, Op, literal, ScopeOptions } from 'sequelize'
+import { AvatarModel } from '../avatar/avatar'
+import { VideoPlaylistModel } from './video-playlist'
+import * as Bluebird from 'bluebird'
+import {
+ MChannelAccountDefault,
+ MChannelActor,
+ MChannelActorAccountDefaultVideos,
+ MChannelAP,
+ MChannelFormattable,
+ MChannelSummaryFormattable
+} from '../../typings/models/video'
+
+export enum ScopeNames {
+ FOR_API = 'FOR_API',
+ SUMMARY = 'SUMMARY',
+ WITH_ACCOUNT = 'WITH_ACCOUNT',
+ WITH_ACTOR = 'WITH_ACTOR',
+ WITH_VIDEOS = 'WITH_VIDEOS',
+ WITH_STATS = 'WITH_STATS'
+}
+
+type AvailableForListOptions = {
+ actorId: number
+}
+
+type AvailableWithStatsOptions = {
+ daysPrior: number
+}
+
+export type SummaryOptions = {
+ 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 base: FindOptions = {
+ attributes: [ 'id', 'name', 'description', 'actorId' ],
+ include: [
+ {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
+ model: ActorModel.unscoped(),
+ required: true,
+ include: [
+ {
+ attributes: [ 'host' ],
+ model: ServerModel.unscoped(),
+ required: false
+ },
+ {
+ model: AvatarModel.unscoped(),
+ required: false
+ }
+ ]
+ }
+ ]
+ }
+
+ if (options.withAccount === true) {
+ base.include.push({
+ model: AccountModel.scope({
+ method: [ AccountModelScopeNames.SUMMARY, { withAccountBlockerIds: options.withAccountBlockerIds } as AccountSummaryOptions ]
+ }),
+ required: true
+ })
+ }
+ return base
+ },
+ [ScopeNames.WITH_ACCOUNT]: {
+ include: [
+ {
+ model: AccountModel,
+ required: true
+ }
+ ]
+ },
+ [ScopeNames.WITH_ACTOR]: {
+ include: [
+ ActorModel
+ ]
+ },
+ [ScopeNames.WITH_VIDEOS]: {
+ include: [
+ VideoModel
+ ]
+ },
+ [ScopeNames.WITH_STATS]: (options: AvailableWithStatsOptions = { daysPrior: 30 }) => ({
+ attributes: {
+ include: [
+ [
+ literal(
+ '(' +
+ `SELECT string_agg(concat_ws('|', t.day, t.views), ',') ` +
+ 'FROM ( ' +
+ 'WITH ' +
+ 'days AS ( ' +
+ `SELECT generate_series(date_trunc('day', now()) - '${options.daysPrior} day'::interval, ` +
+ `date_trunc('day', now()), '1 day'::interval) AS day ` +
+ '), ' +
+ 'views AS ( ' +
+ 'SELECT * ' +
+ 'FROM "videoView" ' +
+ 'WHERE "videoView"."videoId" IN ( ' +
+ 'SELECT "video"."id" ' +
+ 'FROM "video" ' +
+ 'WHERE "video"."channelId" = "VideoChannelModel"."id" ' +
+ ') ' +
+ ') ' +
+ 'SELECT days.day AS day, ' +
+ 'COALESCE(SUM(views.views), 0) AS views ' +
+ 'FROM days ' +
+ `LEFT JOIN views ON date_trunc('day', "views"."createdAt") = days.day ` +
+ 'GROUP BY 1 ' +
+ '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
-
@AllowNull(false)
@Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelNameValid, 'name'))
@Column
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(false)
- @Is('VideoChannelUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.URL.max))
- url: string
+ @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
@UpdatedAt
updatedAt: Date
+ @ForeignKey(() => ActorModel)
+ @Column
+ actorId: number
+
+ @BelongsTo(() => ActorModel, {
+ foreignKey: {
+ allowNull: false
+ },
+ onDelete: 'cascade'
+ })
+ Actor: ActorModel
+
@ForeignKey(() => AccountModel)
@Column
accountId: number
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[]
+
+ @BeforeDestroy
+ static async sendDeleteIfOwned (instance: VideoChannelModel, options) {
+ if (!instance.Actor) {
+ instance.Actor = await instance.$get('Actor', { transaction: options.transaction })
+ }
- @AfterDestroy
- static sendDeleteIfOwned (instance: VideoChannelModel) {
- if (instance.isOwned()) {
- return sendDeleteVideoChannel(instance, undefined)
+ 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 (actorId: number, start: number, count: number, sort: string) {
const query = {
offset: start,
limit: count,
- order: [ getSort(sort) ],
- include: [
- {
- model: AccountModel,
- required: true,
- include: [ { model: ServerModel, required: false } ]
- }
- ]
+ order: getSort(sort)
}
- return VideoChannelModel.findAndCountAll(query)
+ const scopes = {
+ method: [ ScopeNames.FOR_API, { actorId } as AvailableForListOptions ]
+ }
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
- static listByAccount (accountId: number) {
+ static listLocalsForSitemap (sort: string): Bluebird<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)
- .then(({ rows, count }) => {
- return { total: count, data: rows }
- })
+ return VideoChannelModel
+ .unscoped()
+ .findAll(query)
}
- static loadByUUID (uuid: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- uuid
- }
- }
-
- if (t !== undefined) query.transaction = t
+ 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))
- return VideoChannelModel.findOne(query)
- }
-
- static loadByUrl (url: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- url
+ const query = {
+ attributes: {
+ include: attributesInclude
},
- include: [ AccountModel ]
- }
-
- if (t !== undefined) query.transaction = t
-
- return VideoChannelModel.findOne(query)
- }
-
- static loadByUUIDOrUrl (uuid: string, url: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
+ offset: options.start,
+ limit: options.count,
+ order: getSort(options.sort),
where: {
- [ Sequelize.Op.or ]: [
- { uuid },
- { url }
+ [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 + '))'
+ )
]
}
}
- if (t !== undefined) query.transaction = t
-
- return VideoChannelModel.findOne(query)
+ const scopes = {
+ method: [ ScopeNames.FOR_API, { actorId: options.actorId } as AvailableForListOptions ]
+ }
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return { total: count, data: rows }
+ })
}
- static loadByHostAndUUID (fromHost: string, uuid: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- uuid
- },
+ static listByAccount (options: {
+ accountId: number
+ start: number
+ count: number
+ sort: string
+ withStats?: boolean
+ }) {
+ const query = {
+ offset: options.start,
+ limit: options.count,
+ order: getSort(options.sort),
include: [
{
model: AccountModel,
- include: [
- {
- model: ServerModel,
- required: true,
- where: {
- host: fromHost
- }
- }
- ]
+ where: {
+ id: options.accountId
+ },
+ required: true
}
]
}
- if (t !== undefined) query.transaction = t
+ const scopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR ]
+
+ if (options.withStats) {
+ scopes.push({
+ method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ]
+ })
+ }
+
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return { total: count, data: rows }
+ })
+ }
- return VideoChannelModel.findOne(query)
+ static loadByIdAndPopulateAccount (id: number): Bluebird<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): Bluebird<MChannelAccountDefault> {
+ const query = {
where: {
id,
accountId
- },
+ }
+ }
+
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
+ }
+
+ static loadAndPopulateAccount (id: number): Bluebird<MChannelAccountDefault> {
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findByPk(id)
+ }
+
+ static loadByUrlAndPopulateAccount (url: string): Bluebird<MChannelAccountDefault> {
+ const query = {
include: [
{
- model: AccountModel,
- include: [ { model: ServerModel, required: false } ]
+ model: ActorModel,
+ required: true,
+ where: {
+ url
+ }
}
]
}
- return VideoChannelModel.findOne(options)
+ return VideoChannelModel
+ .scope([ ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadAndPopulateAccount (id: number) {
- const options = {
+ 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): Bluebird<MChannelAccountDefault> {
+ const query = {
include: [
{
- model: AccountModel,
- include: [ { model: ServerModel, required: false } ]
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name,
+ serverId: null
+ }
}
]
}
- return VideoChannelModel.findById(id, options)
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadByUUIDAndPopulateAccount (uuid: string) {
- const options = {
- where: {
- uuid
- },
+ static loadByNameAndHostAndPopulateAccount (name: string, host: string): Bluebird<MChannelAccountDefault> {
+ const query = {
include: [
{
- model: AccountModel,
- include: [ { model: ServerModel, required: false } ]
+ model: ActorModel,
+ required: true,
+ where: {
+ preferredUsername: name
+ },
+ include: [
+ {
+ model: ServerModel,
+ required: true,
+ where: { host }
+ }
+ ]
}
]
}
- return VideoChannelModel.findOne(options)
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadAndPopulateAccountAndVideos (id: number) {
+ static loadAndPopulateAccountAndVideos (id: number): Bluebird<MChannelActorAccountDefaultVideos> {
const options = {
include: [
- {
- model: AccountModel,
- include: [ { model: ServerModel, required: false } ]
- },
VideoModel
]
}
- return VideoChannelModel.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 viewsPerDay = this.get('viewsPerDay') as string
+
+ 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,
+ viewsPerDay: viewsPerDay !== undefined
+ ? viewsPerDay.split(',').map(v => {
+ const o = v.split('|')
+ return {
+ date: new Date(o[0]),
+ views: +o[1]
+ }
+ })
+ : undefined
}
- 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 json
+ return Object.assign(actor, videoChannel)
}
- toActivityPubObject () {
- let sharesObject
- if (Array.isArray(this.VideoChannelShares)) {
- const shares: string[] = []
+ toActivityPubObject (this: MChannelAP): ActivityPubActor {
+ const obj = this.Actor.toActivityPubObject(this.name)
- for (const videoChannelShare of this.VideoChannelShares) {
- const shareUrl = getAnnounceActivityPubUrl(this.url, videoChannelShare.Account)
- shares.push(shareUrl)
- }
+ return Object.assign(obj, {
+ summary: this.description,
+ support: this.support,
+ attributedTo: [
+ {
+ type: 'Person' as 'Person',
+ id: this.Account.Actor.url
+ }
+ ]
+ })
+ }
- sharesObject = activityPubCollection(shares)
- }
+ getDisplayName () {
+ return this.name
+ }
- return {
- type: 'VideoChannel' as 'VideoChannel',
- id: this.url,
- uuid: this.uuid,
- content: this.description,
- name: this.name,
- published: this.createdAt.toISOString(),
- updated: this.updatedAt.toISOString(),
- shares: sharesObject
- }
+ isOutdated () {
+ return this.Actor.isOutdated()
}
}
projects / oweals / peertube.git / blobdiff