X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fvideo%2Fvideo-channel.ts;h=410fd6d3f777c4e15c2bb0f509eb2012eb0210de;hb=d0800f7661f13fabe7bb6f4aa0ea50764f106405;hp=835216671730eeaa1955182318d61c3caf4d6262;hpb=134cf2bce96a8c5aefd55154e884964975d8cf23;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts index 835216671..410fd6d3f 100644 --- a/server/models/video/video-channel.ts +++ b/server/models/video/video-channel.ts @@ -1,3 +1,4 @@ +import { FindOptions, Includeable, literal, Op, QueryTypes, ScopeOptions, Transaction, WhereOptions } from 'sequelize' import { AllowNull, BeforeDestroy, @@ -16,46 +17,61 @@ import { 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, VideoChannelSummary } from '../../../shared/models/videos' import { isVideoChannelDescriptionValid, - isVideoChannelNameValid, + isVideoChannelDisplayNameValid, 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 { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants' -import { ServerModel } from '../server/server' -import { FindOptions, Op } from 'sequelize' -import { AvatarModel } from '../avatar/avatar' -import { VideoPlaylistModel } from './video-playlist' -import * as Bluebird from 'bluebird' +import { sendDeleteActor } from '../../lib/activitypub/send' import { - MChannelAccountDefault, + MChannel, MChannelActor, - MChannelActorAccountDefaultVideos, MChannelAP, + MChannelBannerAccountDefault, MChannelFormattable, MChannelSummaryFormattable -} from '../../typings/models/video' +} 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 { VideoPlaylistModel } from './video-playlist' export enum ScopeNames { FOR_API = 'FOR_API', + SUMMARY = 'SUMMARY', WITH_ACCOUNT = 'WITH_ACCOUNT', WITH_ACTOR = 'WITH_ACTOR', + WITH_ACTOR_BANNER = 'WITH_ACTOR_BANNER', WITH_VIDEOS = 'WITH_VIDEOS', - SUMMARY = 'SUMMARY' + WITH_STATS = 'WITH_STATS' } type AvailableForListOptions = { actorId: number + search?: string + host?: string + handles?: string[] + forCount?: boolean +} + +type AvailableWithStatsOptions = { + daysPrior: number } export type SummaryOptions = { + actorRequired?: boolean // Default: true withAccount?: boolean // Default: false withAccountBlockerIds?: number[] } @@ -69,43 +85,100 @@ export type SummaryOptions = { ] })) @Scopes(() => ({ - [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 + [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 ')})`) + } + }) } - if (options.withAccount === true) { - base.include.push({ - model: AccountModel.scope({ - method: [ AccountModelScopeNames.SUMMARY, { withAccountBlockerIds: options.withAccountBlockerIds } as AccountSummaryOptions ] - }), - required: true + const channelInclude: Includeable[] = [] + const accountInclude: Includeable[] = [] + + if (options.forCount !== true) { + accountInclude.push({ + model: ServerModel, + required: false + }) + + accountInclude.push({ + model: ActorImageModel, + as: 'Avatars', + required: false + }) + + channelInclude.push({ + model: ActorImageModel, + as: 'Avatars', + required: false + }) + + channelInclude.push({ + model: ActorImageModel, + as: 'Banners', + required: false }) } - return base - }, - [ScopeNames.FOR_API]: (options: AvailableForListOptions) => { - // Only list local channels OR channels that are on an instance followed by actorId - const inQueryInstanceFollow = buildServerIdsFollowedBy(options.actorId) + if (options.forCount !== true || serverRequired) { + channelInclude.push({ + model: ServerModel, + duplicating: false, + required: serverRequired, + where: whereServer + }) + } return { include: [ @@ -113,36 +186,67 @@ export type SummaryOptions = { attributes: { exclude: unusedActorAttributesForAPI }, - model: ActorModel, + model: ActorModel.unscoped(), where: { - [Op.or]: [ - { - serverId: null - }, - { - serverId: { - [Op.in]: Sequelize.literal(inQueryInstanceFollow) - } - } - ] - } + [Op.and]: whereActorAnd + }, + include: channelInclude }, { - model: AccountModel, + model: AccountModel.unscoped(), required: true, include: [ { attributes: { exclude: unusedActorAttributesForAPI }, - model: ActorModel, // Default scope includes avatar and server - required: true + model: ActorModel.unscoped(), + required: true, + include: accountInclude } ] } ] } }, + [ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => { + const include: Includeable[] = [ + { + attributes: [ 'id', 'preferredUsername', 'url', 'serverId' ], + model: ActorModel.unscoped(), + required: options.actorRequired ?? true, + include: [ + { + 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_ACCOUNT]: { include: [ { @@ -151,15 +255,66 @@ export type SummaryOptions = { } ] }, - [ScopeNames.WITH_VIDEOS]: { + [ScopeNames.WITH_ACTOR]: { include: [ - VideoModel + ActorModel ] }, - [ScopeNames.WITH_ACTOR]: { + [ScopeNames.WITH_ACTOR_BANNER]: { include: [ - ActorModel + { + 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({ @@ -175,10 +330,10 @@ export type SummaryOptions = { } ] }) -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 @@ -219,8 +374,7 @@ export class VideoChannelModel extends Model { @BelongsTo(() => AccountModel, { foreignKey: { allowNull: false - }, - hooks: true + } }) Account: AccountModel @@ -249,6 +403,8 @@ export class VideoChannelModel extends Model { instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) } + await ActorFollowModel.removeFollowsOf(instance.Actor.id, options.transaction) + if (instance.Actor.isOwned()) { return sendDeleteActor(instance.Actor, options.transaction) } @@ -266,25 +422,48 @@ export class VideoChannelModel extends Model { return VideoChannelModel.count(query) } - static listForApi (actorId: number, start: number, count: number, sort: string) { - const query = { - offset: start, - limit: count, - order: getSort(sort) + 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 scopes = { - method: [ ScopeNames.FOR_API, { actorId } as AvailableForListOptions ] + 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 } - return VideoChannelModel - .scope(scopes) - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } - }) } - static listLocalsForSitemap (sort: string): Bluebird { + static listLocalsForSitemap (sort: string): Promise { const query = { attributes: [ ], offset: 0, @@ -305,17 +484,53 @@ export class VideoChannelModel extends Model { .findAll(query) } - static searchForApi (options: { - actorId: number - search: string + static listForApi (parameters: Pick & { 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 { 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: { @@ -324,7 +539,39 @@ export class VideoChannelModel extends Model { offset: options.start, limit: options.count, order: getSort(options.sort), - where: { + 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 + '))' @@ -334,73 +581,69 @@ export class VideoChannelModel extends Model { ) ] } + : 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 scopes = { - method: [ ScopeNames.FOR_API, { actorId: options.actorId } as AvailableForListOptions ] - } - return VideoChannelModel - .scope(scopes) - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } + const scopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR_BANNER ] + + if (options.withStats === true) { + scopes.push({ + method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ] }) + } + + return Promise.all([ + VideoChannelModel.scope(scopes).count(getQuery(true)), + VideoChannelModel.scope(scopes).findAll(getQuery(false)) + ]).then(([ total, data ]) => ({ total, data })) } - static listByAccount (options: { - accountId: number - start: number - count: number - sort: string - }) { + static listAllByAccount (accountId: number): Promise { const query = { - offset: options.start, - limit: options.count, - order: getSort(options.sort), + limit: CONFIG.VIDEO_CHANNELS.MAX_PER_USER, include: [ { - model: AccountModel, + attributes: [], + model: AccountModel.unscoped(), where: { - id: options.accountId + id: accountId }, required: true } ] } - return VideoChannelModel - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } - }) + return VideoChannelModel.findAll(query) } - static loadByIdAndPopulateAccount (id: number): Bluebird { + static loadAndPopulateAccount (id: number, transaction?: Transaction): Promise { return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findByPk(id) + .scope([ ScopeNames.WITH_ACTOR_BANNER, ScopeNames.WITH_ACCOUNT ]) + .findByPk(id, { transaction }) } - static loadByIdAndAccount (id: number, accountId: number): Bluebird { - const query = { - where: { - id, - accountId - } - } - - return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findOne(query) - } - - static loadAndPopulateAccount (id: number): Bluebird { - return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) - .findByPk(id) - } - - static loadByUrlAndPopulateAccount (url: string): Bluebird { + static loadByUrlAndPopulateAccount (url: string): Promise { const query = { include: [ { @@ -408,7 +651,14 @@ export class VideoChannelModel extends Model { required: true, where: { url - } + }, + include: [ + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] } ] } @@ -426,7 +676,7 @@ export class VideoChannelModel extends Model { return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host) } - static loadLocalByNameAndPopulateAccount (name: string): Bluebird { + static loadLocalByNameAndPopulateAccount (name: string): Promise { const query = { include: [ { @@ -435,17 +685,24 @@ export class VideoChannelModel extends Model { where: { preferredUsername: name, serverId: null - } + }, + include: [ + { + model: ActorImageModel, + required: false, + as: 'Banners' + } + ] } ] } return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .scope([ ScopeNames.WITH_ACCOUNT ]) .findOne(query) } - static loadByNameAndHostAndPopulateAccount (name: string, host: string): Bluebird { + static loadByNameAndHostAndPopulateAccount (name: string, host: string): Promise { const query = { include: [ { @@ -459,6 +716,11 @@ export class VideoChannelModel extends Model { model: ServerModel, required: true, where: { host } + }, + { + model: ActorImageModel, + required: false, + as: 'Banners' } ] } @@ -466,22 +728,10 @@ export class VideoChannelModel extends Model { } return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ]) + .scope([ ScopeNames.WITH_ACCOUNT ]) .findOne(query) } - static loadAndPopulateAccountAndVideos (id: number): Bluebird { - const options = { - include: [ - VideoModel - ] - } - - return VideoChannelModel.unscoped() - .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEOS ]) - .findByPk(id, options) - } - toFormattedSummaryJSON (this: MChannelSummaryFormattable): VideoChannelSummary { const actor = this.Actor.toFormattedSummaryJSON() @@ -491,11 +741,31 @@ export class VideoChannelModel extends Model { 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, @@ -503,9 +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 + + ownerAccount: undefined, + + videosCount, + viewsPerDay, + + avatars: actor.avatars, + + // TODO: remove, deprecated in 4.2 + avatar: actor.avatar } if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON() @@ -528,6 +806,10 @@ export class VideoChannelModel extends Model { }) } + getLocalUrl (this: MAccountActor | MChannelActor) { + return WEBSERVER.URL + `/video-channels/` + this.Actor.preferredUsername + } + getDisplayName () { return this.name } @@ -535,4 +817,8 @@ export class VideoChannelModel extends Model { isOutdated () { return this.Actor.isOutdated() } + + setAsUpdated (transaction?: Transaction) { + return setAsUpdated('videoChannel', this.id, transaction) + } }