-import { FindOptions, Includeable, literal, Op, ScopeOptions } from 'sequelize'
+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 { forceNumber, 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 { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
import { sendDeleteActor } from '../../lib/activitypub/send'
import {
- MChannelAccountDefault,
+ MChannel,
MChannelActor,
- MChannelActorAccountDefaultVideos,
MChannelAP,
+ MChannelBannerAccountDefault,
MChannelFormattable,
MChannelSummaryFormattable
} from '../../types/models/video'
import { AccountModel, ScopeNames as AccountModelScopeNames, SummaryOptions as AccountSummaryOptions } from '../account/account'
-import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
-import { ActorFollowModel } from '../activitypub/actor-follow'
-import { AvatarModel } from '../avatar/avatar'
+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'
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[]
+ forCount?: boolean
}
type AvailableWithStatsOptions = {
// 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,
+ model: ActorModel.unscoped(),
where: {
- [Op.or]: [
- {
- serverId: null
- },
- {
- serverId: {
- [Op.in]: Sequelize.literal(inQueryInstanceFollow)
- }
- }
- ]
- }
+ [Op.and]: whereActorAnd
+ },
+ include: channelActorInclude
},
{
- 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: accountActorInclude
}
]
}
[ScopeNames.SUMMARY]: (options: SummaryOptions = {}) => {
const include: Includeable[] = [
{
- attributes: [ 'id', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
+ attributes: [ 'id', 'preferredUsername', 'url', 'serverId' ],
model: ActorModel.unscoped(),
required: options.actorRequired ?? true,
include: [
required: false
},
{
- model: AvatarModel.unscoped(),
+ model: ActorImageModel,
+ as: 'Avatars',
required: false
}
]
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)
+ const daysPrior = forceNumber(options.daysPrior)
return {
attributes: {
')'
),
'viewsPerDay'
+ ],
+ [
+ literal(
+ '(' +
+ 'SELECT COALESCE(SUM("video".views), 0) AS totalViews ' +
+ 'FROM "video" ' +
+ 'WHERE "video"."channelId" = "VideoChannelModel"."id"' +
+ ')'
+ ),
+ 'totalViews'
]
]
}
}
]
})
-export class VideoChannelModel extends Model {
+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
}
}
- return VideoChannelModel.count(query)
+ return VideoChannelModel.unscoped().count(query)
}
- static listForApi (parameters: {
- actorId: number
- start: number
- count: number
- sort: string
- }) {
- const { actorId } = parameters
+ static async getStats () {
- const query = {
- offset: parameters.start,
- limit: parameters.count,
- order: getSort(parameters.sort)
+ 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))
}
- return VideoChannelModel
- .scope({
- method: [ ScopeNames.FOR_API, { actorId } as AvailableForListOptions ]
- })
- .findAndCountAll(query)
- .then(({ rows, count }) => {
- return { total: count, data: rows }
- })
+ 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 listLocalsForSitemap (sort: string): Promise<MChannelActor[]> {
.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)
+ }
+
+ 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<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 + '))'
}
}
- return VideoChannelModel
- .scope({
- method: [ ScopeNames.FOR_API, { actorId: options.actorId } as AvailableForListOptions ]
- })
- .findAndCountAll(query)
- .then(({ rows, count }) => {
- return { total: count, data: rows }
- })
+ 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 listByAccount (options: {
+ static listByAccountForAPI (options: {
accountId: number
start: number
count: number
}
: null
- const query = {
- offset: options.start,
- limit: options.count,
- order: getSort(options.sort),
- include: [
- {
- model: AccountModel,
- where: {
- id: options.accountId
- },
- required: true
- }
- ],
- where
+ 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: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR ]
+ const findScopes: string | ScopeOptions | (string | ScopeOptions)[] = [ ScopeNames.WITH_ACTOR_BANNER ]
if (options.withStats === true) {
- scopes.push({
+ findScopes.push({
method: [ ScopeNames.WITH_STATS, { daysPrior: 30 } as AvailableWithStatsOptions ]
})
}
- return VideoChannelModel
- .scope(scopes)
- .findAndCountAll(query)
- .then(({ rows, count }) => {
- return { total: count, data: rows }
- })
- }
-
- static loadByIdAndPopulateAccount (id: number): Promise<MChannelAccountDefault> {
- return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
- .findByPk(id)
+ return Promise.all([
+ VideoChannelModel.unscoped().count(getQuery(true)),
+ VideoChannelModel.scope(findScopes).findAll(getQuery(false))
+ ]).then(([ total, data ]) => ({ total, data }))
}
- static loadByIdAndAccount (id: number, accountId: number): Promise<MChannelAccountDefault> {
+ static listAllByAccount (accountId: number): Promise<MChannel[]> {
const query = {
- where: {
- id,
- accountId
- }
+ limit: CONFIG.VIDEO_CHANNELS.MAX_PER_USER,
+ include: [
+ {
+ attributes: [],
+ model: AccountModel.unscoped(),
+ 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): Promise<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): Promise<MChannelAccountDefault> {
+ static loadByUrlAndPopulateAccount (url: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
required: true,
where: {
url
- }
+ },
+ include: [
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banners'
+ }
+ ]
}
]
}
return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host)
}
- static loadLocalByNameAndPopulateAccount (name: string): Promise<MChannelAccountDefault> {
+ static loadLocalByNameAndPopulateAccount (name: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
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): Promise<MChannelAccountDefault> {
+ static loadByNameAndHostAndPopulateAccount (name: string, host: string): Promise<MChannelBannerAccountDefault> {
const query = {
include: [
{
model: ServerModel,
required: true,
where: { host }
+ },
+ {
+ model: ActorImageModel,
+ required: false,
+ as: 'Banners'
}
]
}
}
return VideoChannelModel.unscoped()
- .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+ .scope([ ScopeNames.WITH_ACCOUNT ])
.findOne(query)
}
- static loadAndPopulateAccountAndVideos (id: number): Promise<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()
displayName: this.getDisplayName(),
url: actor.url,
host: actor.host,
+ avatars: actor.avatars,
+
+ // TODO: remove, deprecated in 4.2
avatar: actor.avatar
}
}
})
}
+ const totalViews = this.get('totalViews') as number
+
const actor = this.Actor.toFormattedJSON()
const videoChannel = {
id: this.id,
description: this.description,
support: this.support,
isLocal: this.Actor.isOwned(),
- createdAt: this.createdAt,
updatedAt: this.updatedAt,
+
ownerAccount: undefined,
+
videosCount,
- viewsPerDay
+ viewsPerDay,
+ totalViews,
+
+ avatars: actor.avatars,
+
+ // TODO: remove, deprecated in 4.2
+ avatar: actor.avatar
}
if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()
isOutdated () {
return this.Actor.isOutdated()
}
+
+ setAsUpdated (transaction?: Transaction) {
+ return setAsUpdated('videoChannel', this.id, transaction)
+ }
}