X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo-channel.ts;h=ca06048d1c47e65c73231be9d30209f352db8ee9;hb=9c6ca37fc1512a99d420ea90707cebcd06cdc970;hp=fe44d3d53f686a43bda37e28875031702b1a0d72;hpb=fadf619ad61a016c1c7fc53de5a8f398a4f77519;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts index fe44d3d53..ca06048d1 100644 --- a/server/models/video/video-channel.ts +++ b/server/models/video/video-channel.ts @@ -1,42 +1,149 @@ -import * as Sequelize from 'sequelize' import { - AfterDestroy, AllowNull, + BeforeDestroy, BelongsTo, Column, CreatedAt, DataType, Default, + DefaultScope, ForeignKey, - HasMany, + HasMany, IFindOptions, 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 { 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 } 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 { CONFIG, CONSTRAINTS_FIELDS } from '../../initializers' +import { ServerModel } from '../server/server' +import { DefineIndexesOptions } from 'sequelize' +import { AvatarModel } from '../avatar/avatar' +import { VideoPlaylistModel } from './video-playlist' -enum ScopeNames { +// 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' ] + } +] + +export enum ScopeNames { + AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST', WITH_ACCOUNT = 'WITH_ACCOUNT', - WITH_VIDEOS = 'WITH_VIDEOS' + WITH_ACTOR = 'WITH_ACTOR', + WITH_VIDEOS = 'WITH_VIDEOS', + SUMMARY = 'SUMMARY' } +type AvailableForListOptions = { + actorId: number +} + +@DefaultScope({ + include: [ + { + model: () => ActorModel, + required: true + } + ] +}) @Scopes({ + [ScopeNames.SUMMARY]: (withAccount = false) => { + const base: IFindOptions = { + attributes: [ 'name', 'description', 'id', 'actorId' ], + include: [ + { + attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ], + model: ActorModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'host' ], + model: ServerModel.unscoped(), + required: false + }, + { + model: AvatarModel.unscoped(), + required: false + } + ] + } + ] + } + + if (withAccount === true) { + base.include.push({ + model: AccountModel.scope(AccountModelScopeNames.SUMMARY), + required: true + }) + } + + return base + }, + [ScopeNames.AVAILABLE_FOR_LIST]: (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: { + [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, - include: [ { model: () => ServerModel, required: false } ] + required: true } ] }, @@ -44,37 +151,35 @@ enum ScopeNames { include: [ () => VideoModel ] + }, + [ScopeNames.WITH_ACTOR]: { + include: [ + () => ActorModel + ] } }) @Table({ tableName: 'videoChannel', - indexes: [ - { - fields: [ 'accountId' ] - } - ] + indexes }) export class VideoChannelModel extends Model { - @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) + @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(true) + @Default(null) + @Is('VideoChannelSupport', value => throwIfNotValid(value, isVideoChannelSupportValid, 'support')) + @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.SUPPORT.max)) + support: string @CreatedAt createdAt: Date @@ -102,7 +207,7 @@ export class VideoChannelModel extends Model { foreignKey: { allowNull: false }, - onDelete: 'CASCADE' + hooks: true }) Account: AccountModel @@ -111,23 +216,28 @@ export class VideoChannelModel extends Model { 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 }) as ActorModel + } + + if (instance.Actor.isOwned()) { + return sendDeleteActor(instance.Actor, options.transaction) } return undefined @@ -143,14 +253,82 @@ export class VideoChannelModel extends Model { 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: [ + { + attributes: [ 'preferredUsername', 'serverId' ], + model: ActorModel.unscoped(), + where: { + serverId: null + } + } + ] + } + + 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 + '))' + ) + ] + } } - return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findAndCountAll(query) + 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 } }) @@ -158,81 +336,136 @@ export class VideoChannelModel extends Model { 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 loadByUrl (url: string, t?: Sequelize.Transaction) { - const query: IFindOptions = { + static loadByIdAndPopulateAccount (id: number) { + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .findByPk(id) + } + + static loadByIdAndAccount (id: number, accountId: number) { + const query = { + where: { + id, + accountId + } + } + + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .findOne(query) + } + + static loadAndPopulateAccount (id: number) { + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .findByPk(id) + } + + static loadByUUIDAndPopulateAccount (uuid: string) { + const query = { include: [ { model: ActorModel, required: true, where: { - url + uuid } } ] } - if (t !== undefined) query.transaction = t - - return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(query) + return VideoChannelModel + .scope([ ScopeNames.WITH_ACCOUNT ]) + .findOne(query) } - static loadByUUIDOrUrl (uuid: string, url: string, t?: Sequelize.Transaction) { - const query: IFindOptions = { - where: { - [ Sequelize.Op.or ]: [ - { uuid }, - { url } - ] - } + static loadByUrlAndPopulateAccount (url: string) { + const query = { + include: [ + { + model: ActorModel, + required: true, + where: { + url + } + } + ] } - 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 loadByNameWithHostAndPopulateAccount (nameWithHost: string) { + const [ name, host ] = nameWithHost.split('@') + + if (!host || host === CONFIG.WEBSERVER.HOST) return VideoChannelModel.loadLocalByNameAndPopulateAccount(name) - return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(options) + return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host) } - static loadAndPopulateAccount (id: number) { - return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findById(id) + static loadLocalByNameAndPopulateAccount (name: string) { + const query = { + include: [ + { + model: ActorModel, + required: true, + where: { + preferredUsername: name, + serverId: null + } + } + ] + } + + 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: ActorModel, + required: true, + where: { + preferredUsername: name + }, + include: [ + { + model: ServerModel, + required: true, + where: { host } + } + ] + } + ] } - return VideoChannelModel.scope(ScopeNames.WITH_ACCOUNT).findOne(options) + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .findOne(query) } static loadAndPopulateAccountAndVideos (id: number) { @@ -242,39 +475,63 @@ export class VideoChannelModel extends Model { ] } - 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 - } - - 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 + updatedAt: this.updatedAt, + ownerAccount: undefined } - if (this.Account !== undefined) { - json[ 'owner' ] = { - name: this.Account.name, - uuid: this.Account.uuid - } - } + if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON() + + return Object.assign(actor, videoChannel) + } + + toFormattedSummaryJSON (): VideoChannelSummary { + const actor = this.Actor.toFormattedJSON() - if (Array.isArray(this.Videos)) { - json[ 'videos' ] = this.Videos.map(v => v.toFormattedJSON()) + return { + id: this.id, + uuid: actor.uuid, + name: actor.name, + displayName: this.getDisplayName(), + url: actor.url, + host: actor.host, + avatar: actor.avatar } + } + + toActivityPubObject (): ActivityPubActor { + const obj = this.Actor.toActivityPubObject(this.name, 'VideoChannel') + + return Object.assign(obj, { + summary: this.description, + support: this.support, + attributedTo: [ + { + type: 'Person' as 'Person', + id: this.Account.Actor.url + } + ] + }) + } - return json + getDisplayName () { + return this.name } - toActivityPubObject () { - return this.Actor.toActivityPubObject(this.name, this.uuid, 'VideoChannel') + isOutdated () { + return this.Actor.isOutdated() } }