X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo-channel.ts;h=5b50753445647923728d06df81c3f54c2bbb7b23;hb=cda03765fe366f028897e9b02dd4a0a19af3c935;hp=9f80e0b8daab4b8e6629736a7b307f159bf48e37;hpb=8a19bee1a1ee39f973bb37429e4f73c3f2873cdb;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts index 9f80e0b8d..5b5075344 100644 --- a/server/models/video/video-channel.ts +++ b/server/models/video/video-channel.ts @@ -9,32 +9,54 @@ import { DefaultScope, ForeignKey, HasMany, + IFindOptions, Is, Model, Scopes, + Sequelize, Table, UpdatedAt } from 'sequelize-typescript' import { ActivityPubActor } from '../../../shared/models/activitypub' -import { VideoChannel } from '../../../shared/models/videos' +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 } from '../account/account' -import { ActorModel } from '../activitypub/actor' -import { getSort, throwIfNotValid } from '../utils' +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 { CONSTRAINTS_FIELDS } from '../../initializers' -import { AvatarModel } from '../avatar/avatar' +import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants' import { ServerModel } from '../server/server' +import { DefineIndexesOptions } from 'sequelize' +import { AvatarModel } from '../avatar/avatar' +import { VideoPlaylistModel } from './video-playlist' + +// 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 { +export enum ScopeNames { + AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST', WITH_ACCOUNT = 'WITH_ACCOUNT', WITH_ACTOR = 'WITH_ACTOR', - WITH_VIDEOS = 'WITH_VIDEOS' + WITH_VIDEOS = 'WITH_VIDEOS', + SUMMARY = 'SUMMARY' +} + +type AvailableForListOptions = { + actorId: number } @DefaultScope({ @@ -46,23 +68,83 @@ enum ScopeNames { ] }) @Scopes({ - [ScopeNames.WITH_ACCOUNT]: { - include: [ - { - model: () => AccountModel.unscoped(), - required: true, - include: [ - { - model: () => ActorModel.unscoped(), - required: true, - include: [ + [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]: [ { - model: () => AvatarModel.unscoped(), - required: false + 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 } ] }, @@ -79,14 +161,7 @@ enum ScopeNames { }) @Table({ tableName: 'videoChannel', - indexes: [ - { - fields: [ 'accountId' ] - }, - { - fields: [ 'actorId' ] - } - ] + indexes }) export class VideoChannelModel extends Model { @@ -147,6 +222,15 @@ export class VideoChannelModel extends Model { }) Videos: VideoModel[] + @HasMany(() => VideoPlaylistModel, { + foreignKey: { + allowNull: true + }, + onDelete: 'CASCADE', + hooks: true + }) + VideoPlaylists: VideoPlaylistModel[] + @BeforeDestroy static async sendDeleteIfOwned (instance: VideoChannelModel, options) { if (!instance.Actor) { @@ -170,15 +254,81 @@ 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) } + const scopes = { + method: [ ScopeNames.AVAILABLE_FOR_LIST, { actorId } as AvailableForListOptions ] + } return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .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 + '))' + ) + ] + } + } + + 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 } @@ -206,6 +356,12 @@ export class VideoChannelModel extends Model { }) } + 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: { @@ -214,15 +370,15 @@ export class VideoChannelModel extends Model { } } - return VideoChannelModel + return VideoChannelModel.unscoped() .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) .findOne(query) } static loadAndPopulateAccount (id: number) { - return VideoChannelModel + return VideoChannelModel.unscoped() .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findById(id) + .findByPk(id) } static loadByUUIDAndPopulateAccount (uuid: string) { @@ -239,10 +395,36 @@ export class VideoChannelModel extends Model { } return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .scope([ ScopeNames.WITH_ACCOUNT ]) + .findOne(query) + } + + static loadByUrlAndPopulateAccount (url: string) { + 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) { const query = { include: [ @@ -257,7 +439,7 @@ export class VideoChannelModel extends Model { ] } - return VideoChannelModel + return VideoChannelModel.unscoped() .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) .findOne(query) } @@ -282,7 +464,7 @@ export class VideoChannelModel extends Model { ] } - return VideoChannelModel + return VideoChannelModel.unscoped() .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) .findOne(query) } @@ -294,9 +476,9 @@ export class VideoChannelModel extends Model { ] } - return VideoChannelModel + return VideoChannelModel.unscoped() .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEOS ]) - .findById(id, options) + .findByPk(id, options) } toFormattedJSON (): VideoChannel { @@ -317,6 +499,20 @@ export class VideoChannelModel extends Model { return Object.assign(actor, videoChannel) } + toFormattedSummaryJSON (): VideoChannelSummary { + const actor = this.Actor.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') @@ -335,4 +531,8 @@ export class VideoChannelModel extends Model { getDisplayName () { return this.name } + + isOutdated () { + return this.Actor.isOutdated() + } }