+import { FindOptions, Includeable, literal, Op, QueryTypes, ScopeOptions, Transaction, WhereOptions } from 'sequelize'
import {
AllowNull,
BeforeDestroy,
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, literal, ScopeOptions } 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,
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',
WITH_STATS = 'WITH_STATS'
}
type AvailableForListOptions = {
actorId: number
+ search?: string
+ host?: string
+ handles?: string[]
}
type AvailableWithStatsOptions = {
}
export type SummaryOptions = {
+ actorRequired?: boolean // Default: true
withAccount?: boolean // Default: false
withAccountBlockerIds?: number[]
}
// 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
+ })
+ }
+
+ let rootWhere: WhereOptions
+ if (options.handles) {
+ const or: WhereOptions[] = []
+
+ for (const handle of options.handles || []) {
+ const [ preferredUsername, host ] = handle.split('@')
+
+ if (!host || host === WEBSERVER.HOST) {
+ or.push({
+ '$Actor.preferredUsername$': preferredUsername,
+ '$Actor.serverId$': null
+ })
+ } else {
+ or.push({
+ '$Actor.preferredUsername$': preferredUsername,
+ '$Actor.Server.host$': host
+ })
+ }
+ }
+
+ rootWhere = {
+ [Op.or]: or
+ }
+ }
+
return {
+ where: rootWhere,
include: [
{
attributes: {
},
model: ActorModel,
where: {
- [Op.or]: [
- {
- serverId: null
- },
- {
- serverId: {
- [Op.in]: Sequelize.literal(inQueryInstanceFollow)
- }
- }
- ]
- }
+ [Op.and]: whereActorAnd
+ },
+ include: [
+ {
+ model: ServerModel,
+ required: serverRequired,
+ where: whereServer
+ },
+ {
+ model: ActorImageModel,
+ as: 'Avatar',
+ required: false
+ },
+ {
+ model: ActorImageModel,
+ as: 'Banner',
+ required: false
+ }
+ ]
},
{
model: AccountModel,
}
},
[ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
+ const include: Includeable[] = [
+ {
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
+ model: ActorModel.unscoped(),
+ required: options.actorRequired ?? true,
+ include: [
+ {
+ attributes: [ 'host' ],
+ model: ServerModel.unscoped(),
+ required: false
+ },
+ {
+ model: ActorImageModel.unscoped(),
+ as: 'Avatar',
+ required: false
+ }
+ ]
+ }
+ ]
+
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
- }
- ]
- }
- ]
+ attributes: [ 'id', 'name', 'description', 'actorId' ]
}
if (options.withAccount === true) {
- base.include.push({
+ include.push({
model: AccountModel.scope({
method: [ AccountModelScopeNames.SUMMARY, { withAccountBlockerIds: options.withAccountBlockerIds } as AccountSummaryOptions ]
}),
})
}
+ base.include = include
+
return base
},
[ScopeNames.WITH_ACCOUNT]: {
ActorModel
]
},
+ [ScopeNames.WITH_ACTOR_BANNER]: {
+ include: [
+ {
+ model: ActorModel,
+ include: [
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banner'
+ }
+ ]
+ }
+ ]
+ },
[ScopeNames.WITH_VIDEOS]: {
include: [
VideoModel
]
},
- [ScopeNames.WITH_STATS]: (options: AvailableWithStatsOptions = { daysPrior: 30 }) => ({
- attributes: {
- include: [
- [
- literal(
- '(' +
- `SELECT string_agg(concat_ws('|', t.day, t.views), ',') ` +
- 'FROM ( ' +
- 'WITH ' +
- 'days AS ( ' +
- `SELECT generate_series(date_trunc('day', now()) - '${options.daysPrior} day'::interval, ` +
- `date_trunc('day', now()), '1 day'::interval) AS day ` +
- '), ' +
- 'views AS ( ' +
- 'SELECT * ' +
- 'FROM "videoView" ' +
- 'WHERE "videoView"."videoId" IN ( ' +
- 'SELECT "video"."id" ' +
- 'FROM "video" ' +
- 'WHERE "video"."channelId" = "VideoChannelModel"."id" ' +
+ [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(views.views), 0) AS views ' +
- 'FROM days ' +
- `LEFT JOIN views ON date_trunc('day', "views"."createdAt") = days.day ` +
- 'GROUP BY 1 ' +
- 'ORDER BY day ' +
- ') t' +
- ')'
- ),
- 'viewsPerDay'
+ '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',
}
]
})
-export class VideoChannelModel extends Model<VideoChannelModel> {
+export class VideoChannelModel extends Model<Partial<AttributesOnly<VideoChannelModel>>> {
@AllowNull(false)
- @Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelNameValid, 'name'))
+ @Is('VideoChannelName', value => throwIfNotValid(value, isVideoChannelDisplayNameValid, 'name'))
@Column
name: string
@BelongsTo(() => AccountModel, {
foreignKey: {
allowNull: false
- },
- hooks: true
+ }
})
Account: AccountModel
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)
}
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<MChannelActor[]> {
+ static listLocalsForSitemap (sort: string): Promise<MChannelActor[]> {
const query = {
attributes: [ ],
offset: 0,
.findAll(query)
}
- static searchForApi (options: {
- actorId: number
- search: string
+ static listForApi (parameters: Pick<AvailableForListOptions, 'actorId'> & {
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 = {
- attributes: {
- include: attributesInclude
- },
- offset: options.start,
- limit: options.count,
- order: getSort(options.sort),
- where: {
+ offset: parameters.start,
+ limit: parameters.count,
+ order: getSort(parameters.sort)
+ }
+
+ return VideoChannelModel
+ .scope({
+ method: [ ScopeNames.FOR_API, { actorId } as AvailableForListOptions ]
+ })
+ .findAndCountAll(query)
+ .then(({ rows, count }) => {
+ return { total: count, data: rows }
+ })
+ }
+
+ static searchForApi (options: Pick<AvailableForListOptions, 'actorId' | 'search' | 'host' | 'handles'> & {
+ 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 + '))'
}
}
- const scopes = {
- method: [ ScopeNames.FOR_API, { actorId: options.actorId } as AvailableForListOptions ]
+ const query = {
+ attributes: {
+ include: attributesInclude
+ },
+ offset: options.start,
+ limit: options.count,
+ order: getSort(options.sort),
+ where
}
+
return VideoChannelModel
- .scope(scopes)
+ .scope({
+ method: [ ScopeNames.FOR_API, pick(options, [ 'actorId', 'host', 'handles' ]) as AvailableForListOptions ]
+ })
.findAndCountAll(query)
.then(({ rows, count }) => {
return { total: count, data: rows }
})
}
- static listByAccount (options: {
+ 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 query = {
offset: options.start,
limit: options.count,
},
required: true
}
- ]
+ ],
+ where
}
- const scopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR ]
+ const scopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR_BANNER ]
- if (options.withStats) {
+ if (options.withStats === true) {
scopes.push({
method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ]
})
})
}
- static loadByIdAndPopulateAccount (id: number): Bluebird<MChannelAccountDefault> {
- return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
- .findByPk(id)
- }
-
- static loadByIdAndAccount (id: number, accountId: number): Bluebird<MChannelAccountDefault> {
+ static listAllByAccount (accountId: number) {
const query = {
- where: {
- id,
- accountId
- }
+ limit: CONFIG.VIDEO_CHANNELS.MAX_PER_USER,
+ include: [
+ {
+ attributes: [],
+ model: AccountModel,
+ where: {
+ id: accountId
+ },
+ required: true
+ }
+ ]
}
- return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
- .findOne(query)
+ return VideoChannelModel.findAll(query)
}
- static loadAndPopulateAccount (id: number): Bluebird<MChannelAccountDefault> {
+ static loadAndPopulateAccount (id: number, transaction?: Transaction): Promise<MChannelBannerAccountDefault> {
return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
- .findByPk(id)
+ .scope([ ScopeNames.WITH_ACTOR_BANNER, ScopeNames.WITH_ACCOUNT ])
+ .findByPk(id, { transaction })
}
- static loadByUrlAndPopulateAccount (url: string): Bluebird<MChannelAccountDefault> {
+ static loadByUrlAndPopulateAccount (url: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
required: true,
where: {
url
- }
+ },
+ include: [
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banner'
+ }
+ ]
}
]
}
return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host)
}
- static loadLocalByNameAndPopulateAccount (name: string): Bluebird<MChannelAccountDefault> {
+ static loadLocalByNameAndPopulateAccount (name: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
where: {
preferredUsername: name,
serverId: null
- }
+ },
+ include: [
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banner'
+ }
+ ]
}
]
}
return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .scope([ ScopeNames.WITH_ACCOUNT ])
.findOne(query)
}
- static loadByNameAndHostAndPopulateAccount (name: string, host: string): Bluebird<MChannelAccountDefault> {
+ static loadByNameAndHostAndPopulateAccount (name: string, host: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
model: ServerModel,
required: true,
where: { host }
+ },
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banner'
}
]
}
}
return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .scope([ ScopeNames.WITH_ACCOUNT ])
.findOne(query)
}
- static loadAndPopulateAccountAndVideos (id: number): Bluebird<MChannelActorAccountDefaultVideos> {
- 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()
}
toFormattedJSON (this: MChannelFormattable): VideoChannel {
- const viewsPerDay = this.get('viewsPerDay') as string
+ 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 = {
description: this.description,
support: this.support,
isLocal: this.Actor.isOwned(),
- createdAt: this.createdAt,
updatedAt: this.updatedAt,
ownerAccount: undefined,
- viewsPerDay: viewsPerDay !== undefined
- ? viewsPerDay.split(',').map(v => {
- const o = v.split('|')
- return {
- date: new Date(o[0]),
- views: +o[1]
- }
- })
- : undefined
+ videosCount,
+ viewsPerDay
}
if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()
})
}
+ 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)
+ }
}