X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo-channel.ts;h=d6dd1b8bbca6bec237cbf7540627399425d8b3ee;hb=4ec52d04dcc5d664612331f8e08d7d90da990415;hp=6567b00d69475bc9037218442740eff6a1f2345c;hpb=c5a893d5363ce1fd681751cf48977086a35d5724;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts index 6567b00d6..d6dd1b8bb 100644 --- a/server/models/video/video-channel.ts +++ b/server/models/video/video-channel.ts @@ -1,71 +1,327 @@ +import { FindOptions, Includeable, literal, Op, QueryTypes, ScopeOptions, Transaction, WhereOptions } from 'sequelize' import { - AllowNull, BeforeDestroy, BelongsTo, Column, CreatedAt, DefaultScope, ForeignKey, HasMany, Is, Model, Scopes, Table, - UpdatedAt, Default, DataType + AllowNull, + BeforeDestroy, + BelongsTo, + Column, + CreatedAt, + DataType, + Default, + DefaultScope, + ForeignKey, + HasMany, + Is, + Model, + Scopes, + Sequelize, + Table, + UpdatedAt } from 'sequelize-typescript' +import { CONFIG } from '@server/initializers/config' +import { MAccountActor } from '@server/types/models' +import { pick } from '@shared/core-utils' +import { AttributesOnly } from '@shared/typescript-utils' import { ActivityPubActor } from '../../../shared/models/activitypub' -import { VideoChannel } from '../../../shared/models/videos' +import { VideoChannel, VideoChannelSummary } from '../../../shared/models/videos' import { - isVideoChannelDescriptionValid, isVideoChannelNameValid, + isVideoChannelDescriptionValid, + isVideoChannelDisplayNameValid, isVideoChannelSupportValid } from '../../helpers/custom-validators/video-channels' -import { logger } from '../../helpers/logger' +import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants' import { sendDeleteActor } from '../../lib/activitypub/send' -import { AccountModel } from '../account/account' -import { ActorModel } from '../activitypub/actor' -import { getSort, throwIfNotValid } from '../utils' +import { + MChannel, + MChannelActor, + MChannelAP, + MChannelBannerAccountDefault, + MChannelFormattable, + MChannelSummaryFormattable +} from '../../types/models/video' +import { AccountModel, ScopeNames as AccountModelScopeNames, SummaryOptions as AccountSummaryOptions } from '../account/account' +import { ActorModel, unusedActorAttributesForAPI } from '../actor/actor' +import { ActorFollowModel } from '../actor/actor-follow' +import { ActorImageModel } from '../actor/actor-image' +import { ServerModel } from '../server/server' +import { setAsUpdated } from '../shared' +import { buildServerIdsFollowedBy, buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils' import { VideoModel } from './video' -import { CONSTRAINTS_FIELDS } from '../../initializers' -import { AvatarModel } from '../avatar/avatar' +import { VideoPlaylistModel } from './video-playlist' -enum ScopeNames { +export enum ScopeNames { + FOR_API = 'FOR_API', + SUMMARY = 'SUMMARY', WITH_ACCOUNT = 'WITH_ACCOUNT', WITH_ACTOR = 'WITH_ACTOR', - WITH_VIDEOS = 'WITH_VIDEOS' + WITH_ACTOR_BANNER = 'WITH_ACTOR_BANNER', + WITH_VIDEOS = 'WITH_VIDEOS', + WITH_STATS = 'WITH_STATS' +} + +type AvailableForListOptions = { + actorId: number + search?: string + host?: string + handles?: string[] + forCount?: boolean } -@DefaultScope({ +type AvailableWithStatsOptions = { + daysPrior: number +} + +export type SummaryOptions = { + actorRequired?: boolean // Default: true + withAccount?: boolean // Default: false + withAccountBlockerIds?: number[] +} + +@DefaultScope(() => ({ include: [ { - model: () => ActorModel, + model: ActorModel, required: true } ] -}) -@Scopes({ - [ScopeNames.WITH_ACCOUNT]: { - include: [ +})) +@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) + + const whereActorAnd: WhereOptions[] = [ + { + [Op.or]: [ + { + serverId: null + }, + { + serverId: { + [Op.in]: Sequelize.literal(inQueryInstanceFollow) + } + } + ] + } + ] + + let serverRequired = false + let whereServer: WhereOptions + + if (options.host && options.host !== WEBSERVER.HOST) { + serverRequired = true + whereServer = { host: options.host } + } + + if (options.host === WEBSERVER.HOST) { + whereActorAnd.push({ + serverId: null + }) + } + + if (Array.isArray(options.handles) && options.handles.length !== 0) { + const or: string[] = [] + + for (const handle of options.handles || []) { + const [ preferredUsername, host ] = handle.split('@') + + if (!host || host === WEBSERVER.HOST) { + or.push(`("preferredUsername" = ${VideoChannelModel.sequelize.escape(preferredUsername)} AND "serverId" IS NULL)`) + } else { + or.push( + `(` + + `"preferredUsername" = ${VideoChannelModel.sequelize.escape(preferredUsername)} ` + + `AND "host" = ${VideoChannelModel.sequelize.escape(host)}` + + `)` + ) + } + } + + whereActorAnd.push({ + id: { + [Op.in]: literal(`(SELECT "actor".id FROM actor LEFT JOIN server on server.id = actor."serverId" WHERE ${or.join(' OR ')})`) + } + }) + } + + const channelActorInclude: Includeable[] = [] + const accountActorInclude: Includeable[] = [] + + if (options.forCount !== true) { + accountActorInclude.push({ + model: ServerModel, + required: false + }) + + accountActorInclude.push({ + model: ActorImageModel, + as: 'Avatars', + required: false + }) + + channelActorInclude.push({ + model: ActorImageModel, + as: 'Avatars', + required: false + }) + + channelActorInclude.push({ + model: ActorImageModel, + as: 'Banners', + required: false + }) + } + + if (options.forCount !== true || serverRequired) { + channelActorInclude.push({ + model: ServerModel, + duplicating: false, + required: serverRequired, + where: whereServer + }) + } + + return { + include: [ + { + attributes: { + exclude: unusedActorAttributesForAPI + }, + model: ActorModel.unscoped(), + where: { + [Op.and]: whereActorAnd + }, + include: channelActorInclude + }, + { + model: AccountModel.unscoped(), + required: true, + include: [ + { + attributes: { + exclude: unusedActorAttributesForAPI + }, + model: ActorModel.unscoped(), + required: true, + include: accountActorInclude + } + ] + } + ] + } + }, + [ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => { + const include: Includeable[] = [ { - model: () => AccountModel.unscoped(), - required: true, + attributes: [ 'id', 'preferredUsername', 'url', 'serverId' ], + model: ActorModel.unscoped(), + required: options.actorRequired ?? true, include: [ { - model: () => ActorModel.unscoped(), - required: true, - include: [ - { - model: () => AvatarModel.unscoped(), - required: false - } - ] + attributes: [ 'host' ], + model: ServerModel.unscoped(), + required: false + }, + { + model: ActorImageModel, + as: 'Avatars', + 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_VIDEOS]: { + [ScopeNames.WITH_ACCOUNT]: { include: [ - () => VideoModel + { + model: AccountModel, + required: true + } ] }, [ScopeNames.WITH_ACTOR]: { include: [ - () => ActorModel + ActorModel + ] + }, + [ScopeNames.WITH_ACTOR_BANNER]: { + include: [ + { + model: ActorModel, + include: [ + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] + } + ] + }, + [ScopeNames.WITH_VIDEOS]: { + include: [ + 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' ] }, @@ -74,22 +330,22 @@ enum ScopeNames { } ] }) -export class VideoChannelModel extends Model { +export class VideoChannelModel extends Model>> { @AllowNull(false) - @Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelNameValid, 'name')) + @Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelDisplayNameValid, 'name')) @Column name: string @AllowNull(true) @Default(null) - @Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description')) + @Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.DESCRIPTION.max)) description: string @AllowNull(true) @Default(null) - @Is('VideoChannelSupport', value => throwIfNotValid(value, isVideoChannelSupportValid, 'support')) + @Is('VideoChannelSupport', value => throwIfNotValid(value, isVideoChannelSupportValid, 'support', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.SUPPORT.max)) support: string @@ -118,8 +374,7 @@ export class VideoChannelModel extends Model { @BelongsTo(() => AccountModel, { foreignKey: { allowNull: false - }, - hooks: true + } }) Account: AccountModel @@ -133,15 +388,24 @@ 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) { - instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) as ActorModel + instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) } - if (instance.Actor.isOwned()) { - logger.debug('Sending delete of actor of video channel %s.', instance.Actor.url) + await ActorFollowModel.removeFollowsOf(instance.Actor.id, options.transaction) + if (instance.Actor.isOwned()) { return sendDeleteActor(instance.Actor, options.transaction) } @@ -155,30 +419,213 @@ export class VideoChannelModel extends Model { } } - return VideoChannelModel.count(query) + return VideoChannelModel.unscoped().count(query) + } + + static async getStats () { + + function getActiveVideoChannels (days: number) { + const options = { + type: QueryTypes.SELECT as QueryTypes.SELECT, + raw: true + } + + const query = ` +SELECT COUNT(DISTINCT("VideoChannelModel"."id")) AS "count" +FROM "videoChannel" AS "VideoChannelModel" +INNER JOIN "video" AS "Videos" +ON "VideoChannelModel"."id" = "Videos"."channelId" +AND ("Videos"."publishedAt" > Now() - interval '${days}d') +INNER JOIN "account" AS "Account" +ON "VideoChannelModel"."accountId" = "Account"."id" +INNER JOIN "actor" AS "Account->Actor" +ON "Account"."actorId" = "Account->Actor"."id" +AND "Account->Actor"."serverId" IS NULL +LEFT OUTER JOIN "server" AS "Account->Actor->Server" +ON "Account->Actor"."serverId" = "Account->Actor->Server"."id"` + + return VideoChannelModel.sequelize.query<{ count: string }>(query, options) + .then(r => parseInt(r[0].count, 10)) + } + + const totalLocalVideoChannels = await VideoChannelModel.count() + const totalLocalDailyActiveVideoChannels = await getActiveVideoChannels(1) + const totalLocalWeeklyActiveVideoChannels = await getActiveVideoChannels(7) + const totalLocalMonthlyActiveVideoChannels = await getActiveVideoChannels(30) + const totalHalfYearActiveVideoChannels = await getActiveVideoChannels(180) + + return { + totalLocalVideoChannels, + totalLocalDailyActiveVideoChannels, + totalLocalWeeklyActiveVideoChannels, + totalLocalMonthlyActiveVideoChannels, + totalHalfYearActiveVideoChannels + } } - static listForApi (start: number, count: number, sort: string) { + static listLocalsForSitemap (sort: string): Promise { const query = { - offset: start, - limit: count, - order: getSort(sort) + attributes: [ ], + offset: 0, + order: getSort(sort), + include: [ + { + attributes: [ 'preferredUsername', 'serverId' ], + model: ActorModel.unscoped(), + where: { + serverId: null + } + } + ] } return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } + .unscoped() + .findAll(query) + } + + static listForApi (parameters: Pick & { + start: number + count: number + sort: string + }) { + const { actorId } = parameters + + const query = { + offset: parameters.start, + limit: parameters.count, + order: getSort(parameters.sort) + } + + const getScope = (forCount: boolean) => { + return { method: [ ScopeNames.FOR_API, { actorId, forCount } as AvailableForListOptions ] } + } + + return Promise.all([ + VideoChannelModel.scope(getScope(true)).count(), + VideoChannelModel.scope(getScope(false)).findAll(query) + ]).then(([ total, data ]) => ({ total, data })) + } + + static searchForApi (options: Pick & { + start: number + count: number + sort: string + }) { + let attributesInclude: any[] = [ literal('0 as similarity') ] + let where: WhereOptions + + if (options.search) { + const escapedSearch = VideoChannelModel.sequelize.escape(options.search) + const escapedLikeSearch = VideoChannelModel.sequelize.escape('%' + options.search + '%') + attributesInclude = [ createSimilarityAttribute('VideoChannelModel.name', options.search) ] + + 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 + '))' + ) + ] + } + } + + const query = { + attributes: { + include: attributesInclude + }, + offset: options.start, + limit: options.count, + order: getSort(options.sort), + where + } + + const getScope = (forCount: boolean) => { + return { + method: [ + ScopeNames.FOR_API, { + ...pick(options, [ 'actorId', 'host', 'handles' ]), + + forCount + } as AvailableForListOptions + ] + } + } + + return Promise.all([ + VideoChannelModel.scope(getScope(true)).count(query), + VideoChannelModel.scope(getScope(false)).findAll(query) + ]).then(([ total, data ]) => ({ total, data })) + } + + static listByAccountForAPI (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 getQuery = (forCount: boolean) => { + const accountModel = forCount + ? AccountModel.unscoped() + : AccountModel + + return { + offset: options.start, + limit: options.count, + order: getSort(options.sort), + include: [ + { + model: accountModel, + where: { + id: options.accountId + }, + required: true + } + ], + where + } + } + + const findScopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR_BANNER ] + + if (options.withStats === true) { + findScopes.push({ + method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ] }) + } + + return Promise.all([ + VideoChannelModel.unscoped().count(getQuery(true)), + VideoChannelModel.scope(findScopes).findAll(getQuery(false)) + ]).then(([ total, data ]) => ({ total, data })) } - static listByAccount (accountId: number) { + static listAllByAccount (accountId: number): Promise { const query = { - order: getSort('createdAt'), + limit: CONFIG.VIDEO_CHANNELS.MAX_PER_USER, include: [ { - model: AccountModel, + attributes: [], + model: AccountModel.unscoped(), where: { id: accountId }, @@ -187,63 +634,138 @@ export class VideoChannelModel extends Model { ] } - return VideoChannelModel - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } - }) + return VideoChannelModel.findAll(query) } - static loadByIdAndAccount (id: number, accountId: number) { - const options = { - where: { - id, - accountId - } + static loadAndPopulateAccount (id: number, transaction?: Transaction): Promise { + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACTOR_BANNER, ScopeNames.WITH_ACCOUNT ]) + .findByPk(id, { transaction }) + } + + static loadByUrlAndPopulateAccount (url: string): Promise { + const query = { + include: [ + { + model: ActorModel, + required: true, + where: { + url + }, + include: [ + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] + } + ] } return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findOne(options) + .scope([ ScopeNames.WITH_ACCOUNT ]) + .findOne(query) } - static loadAndPopulateAccount (id: number) { - return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findById(id) + static loadByNameWithHostAndPopulateAccount (nameWithHost: string) { + const [ name, host ] = nameWithHost.split('@') + + if (!host || host === WEBSERVER.HOST) return VideoChannelModel.loadLocalByNameAndPopulateAccount(name) + + return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host) } - static loadByUUIDAndPopulateAccount (uuid: string) { - const options = { + static loadLocalByNameAndPopulateAccount (name: string): Promise { + const query = { include: [ { model: ActorModel, required: true, where: { - uuid - } + preferredUsername: name, + serverId: null + }, + include: [ + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] } ] } - return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findOne(options) + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACCOUNT ]) + .findOne(query) } - static loadAndPopulateAccountAndVideos (id: number) { - const options = { + static loadByNameAndHostAndPopulateAccount (name: string, host: string): Promise { + const query = { include: [ - VideoModel + { + model: ActorModel, + required: true, + where: { + preferredUsername: name + }, + include: [ + { + model: ServerModel, + required: true, + where: { host } + }, + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] + } ] } - return VideoChannelModel - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEOS ]) - .findById(id, options) + return VideoChannelModel.unscoped() + .scope([ ScopeNames.WITH_ACCOUNT ]) + .findOne(query) } - toFormattedJSON (): VideoChannel { + 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, + avatars: actor.avatars, + + // TODO: remove, deprecated in 4.2 + avatar: actor.avatar + } + } + + 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, @@ -251,10 +773,17 @@ export class VideoChannelModel extends Model { description: this.description, support: this.support, isLocal: this.Actor.isOwned(), - createdAt: this.createdAt, updatedAt: this.updatedAt, + ownerAccount: undefined, - videos: undefined + + videosCount, + viewsPerDay, + + avatars: actor.avatars, + + // TODO: remove, deprecated in 4.2 + avatar: actor.avatar } if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON() @@ -262,8 +791,8 @@ export class VideoChannelModel extends Model { return Object.assign(actor, videoChannel) } - toActivityPubObject (): ActivityPubActor { - const obj = this.Actor.toActivityPubObject(this.name, 'VideoChannel') + toActivityPubObject (this: MChannelAP): ActivityPubActor { + const obj = this.Actor.toActivityPubObject(this.name) return Object.assign(obj, { summary: this.description, @@ -277,7 +806,19 @@ export class VideoChannelModel extends Model { }) } + getLocalUrl (this: MAccountActor | MChannelActor) { + return WEBSERVER.URL + `/video-channels/` + this.Actor.preferredUsername + } + getDisplayName () { return this.name } + + isOutdated () { + return this.Actor.isOutdated() + } + + setAsUpdated (transaction?: Transaction) { + return setAsUpdated('videoChannel', this.id, transaction) + } }