-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 { ActivityPubActor } from '../../../shared/models/activitypub'
+import { VideoChannel } from '../../../shared/models/videos'
+import {
+ isVideoChannelDescriptionValid,
+ isVideoChannelNameValid,
+ isVideoChannelSupportValid
+} from '../../helpers/custom-validators/video-channels'
+import { sendDeleteActor } from '../../lib/activitypub/send'
import { AccountModel } from '../account/account'
-import { ServerModel } from '../server/server'
-import { getSort, throwIfNotValid } from '../utils'
+import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
+import { buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
import { VideoModel } from './video'
-import { VideoChannelShareModel } from './video-channel-share'
+import { CONSTRAINTS_FIELDS } from '../../initializers'
+import { ServerModel } from '../server/server'
+import { DefineIndexesOptions } from 'sequelize'
-@Table({
- tableName: 'videoChannel',
- indexes: [
+// FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation
+const indexes: DefineIndexesOptions[] = [
+ buildTrigramSearchIndex('video_channel_name_trigram', 'name'),
+
+ {
+ fields: [ 'accountId' ]
+ },
+ {
+ fields: [ 'actorId' ]
+ }
+]
+
+enum ScopeNames {
+ AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
+ WITH_ACCOUNT = 'WITH_ACCOUNT',
+ WITH_ACTOR = 'WITH_ACTOR',
+ WITH_VIDEOS = 'WITH_VIDEOS'
+}
+
+type AvailableForListOptions = {
+ actorId: number
+}
+
+@DefaultScope({
+ include: [
{
- fields: [ 'accountId' ]
+ model: () => ActorModel,
+ required: true
}
]
})
-export class VideoChannelModel extends Model<VideoChannelModel> {
+@Scopes({
+ [ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => {
+ const actorIdNumber = parseInt(options.actorId + '', 10)
- @AllowNull(false)
- @Default(DataType.UUIDV4)
- @IsUUID(4)
- @Column(DataType.UUID)
- uuid: string
+ // Only list local channels OR channels that are on an instance followed by actorId
+ const inQueryInstanceFollow = '(' +
+ 'SELECT "actor"."serverId" FROM "actorFollow" ' +
+ 'INNER JOIN "actor" ON actor.id= "actorFollow"."targetActorId" ' +
+ 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
+ ')'
+
+ return {
+ include: [
+ {
+ attributes: {
+ exclude: unusedActorAttributesForAPI
+ },
+ model: ActorModel,
+ where: {
+ [Sequelize.Op.or]: [
+ {
+ serverId: null
+ },
+ {
+ serverId: {
+ [ Sequelize.Op.in ]: Sequelize.literal(inQueryInstanceFollow)
+ }
+ }
+ ]
+ }
+ },
+ {
+ model: AccountModel,
+ required: true,
+ include: [
+ {
+ attributes: {
+ exclude: unusedActorAttributesForAPI
+ },
+ model: ActorModel, // Default scope includes avatar and server
+ required: true
+ }
+ ]
+ }
+ ]
+ }
+ },
+ [ScopeNames.WITH_ACCOUNT]: {
+ include: [
+ {
+ model: () => AccountModel,
+ required: true
+ }
+ ]
+ },
+ [ScopeNames.WITH_VIDEOS]: {
+ include: [
+ () => VideoModel
+ ]
+ },
+ [ScopeNames.WITH_ACTOR]: {
+ include: [
+ () => ActorModel
+ ]
+ }
+})
+@Table({
+ tableName: 'videoChannel',
+ indexes
+})
+export class VideoChannelModel extends Model<VideoChannelModel> {
@AllowNull(false)
@Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelNameValid, 'name'))
name: string
@AllowNull(true)
+ @Default(null)
@Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description'))
- @Column
+ @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'))
+ @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, {
- foreignKey: {
- name: 'channelId',
- allowNull: false
- },
- onDelete: 'CASCADE'
- })
- VideoChannelShares: VideoChannelShareModel[]
+ @BeforeDestroy
+ static async sendDeleteIfOwned (instance: VideoChannelModel, options) {
+ if (!instance.Actor) {
+ instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) as ActorModel
+ }
- @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) ],
+ order: getSort(sort)
+ }
+
+ const scopes = {
+ method: [ ScopeNames.AVAILABLE_FOR_LIST, { actorId } as AvailableForListOptions ]
+ }
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return { total: count, data: rows }
+ })
+ }
+
+ static listLocalsForSitemap (sort: string) {
+ const query = {
+ attributes: [ ],
+ offset: 0,
+ order: getSort(sort),
include: [
{
- model: AccountModel,
- required: true,
- include: [ { model: ServerModel, required: false } ]
+ attributes: [ 'preferredUsername', 'serverId' ],
+ model: ActorModel.unscoped(),
+ where: {
+ 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: {
+ [Sequelize.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 + '))'
+ )
+ ]
+ }
+ }
+
+ const scopes = {
+ method: [ ScopeNames.AVAILABLE_FOR_LIST, { actorId: options.actorId } as AvailableForListOptions ]
+ }
+ return VideoChannelModel
+ .scope(scopes)
+ .findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
static listByAccount (accountId: number) {
const query = {
- order: [ getSort('createdAt') ],
+ order: getSort('createdAt'),
include: [
{
model: AccountModel,
where: {
id: accountId
},
- required: true,
- include: [ { model: ServerModel, required: false } ]
+ required: true
}
]
}
- return VideoChannelModel.findAndCountAll(query)
+ return VideoChannelModel
+ .findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
- static loadByUUID (uuid: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- uuid
- }
- }
-
- if (t !== undefined) query.transaction = t
-
- return VideoChannelModel.findOne(query)
+ static loadByIdAndPopulateAccount (id: number) {
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findById(id)
}
- static loadByUrl (url: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- url
- },
- 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> = {
+ static loadByIdAndAccount (id: number, accountId: number) {
+ const query = {
where: {
- [ Sequelize.Op.or ]: [
- { uuid },
- { url }
- ]
+ id,
+ accountId
}
}
- if (t !== undefined) query.transaction = t
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
+ }
- return VideoChannelModel.findOne(query)
+ static loadAndPopulateAccount (id: number) {
+ return VideoChannelModel.unscoped()
+ .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .findById(id)
}
- static loadByHostAndUUID (fromHost: string, uuid: string, t?: Sequelize.Transaction) {
- const query: IFindOptions<VideoChannelModel> = {
- where: {
- uuid
- },
+ static loadByUUIDAndPopulateAccount (uuid: string) {
+ const query = {
include: [
{
- model: AccountModel,
- include: [
- {
- model: ServerModel,
- required: true,
- where: {
- host: fromHost
- }
- }
- ]
+ model: ActorModel,
+ required: true,
+ where: {
+ uuid
+ }
}
]
}
- if (t !== undefined) query.transaction = t
-
- return VideoChannelModel.findOne(query)
+ return VideoChannelModel
+ .scope([ ScopeNames.WITH_ACCOUNT ])
+ .findOne(query)
}
- static loadByIdAndAccount (id: number, accountId: number) {
- const options = {
- where: {
- id,
- accountId
- },
+ static loadByUrlAndPopulateAccount (url: string) {
+ 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 loadLocalByNameAndPopulateAccount (name: string) {
+ 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) {
+ 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) {
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 ])
+ .findById(id, options)
}
- isOwned () {
- return this.remote === false
- }
-
- toFormattedJSON () {
- const json = {
+ toFormattedJSON (): VideoChannel {
+ 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
- }
-
- if (this.Account !== undefined) {
- json[ 'owner' ] = {
- name: this.Account.name,
- uuid: this.Account.uuid
- }
+ updatedAt: this.updatedAt,
+ ownerAccount: undefined
}
- if (Array.isArray(this.Videos)) {
- json[ 'videos' ] = this.Videos.map(v => v.toFormattedJSON())
- }
+ if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()
- return json
+ return Object.assign(actor, videoChannel)
}
- toActivityPubObject () {
- let sharesObject
- if (Array.isArray(this.VideoChannelShares)) {
- const shares: string[] = []
+ toActivityPubObject (): ActivityPubActor {
+ const obj = this.Actor.toActivityPubObject(this.name, 'VideoChannel')
- 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 / github / Chocobozzz / PeerTube.git / blobdiff