// SPDX-FileCopyrightText: 2024 Mehdi Benadel // SPDX-FileCopyrightText: 2024 John Livingston // // SPDX-License-Identifier: AGPL-3.0-only import type { RegisterClientOptions } from '@peertube/peertube-types/client' import type { ChannelLiveChatInfos, ChannelConfiguration, ChannelConfigurationOptions, ChannelEmojisConfiguration, ChannelEmojis, CustomEmojiDefinition } from 'shared/lib/types' import { ValidationError, ValidationErrorType } from '../../lib/models/validation' import { getBaseRoute } from '../../../utils/uri' import { maxEmojisPerChannel } from 'shared/lib/emojis' import { channelTermsMaxLength } from 'shared/lib/constants' export class ChannelDetailsService { public _registerClientOptions: RegisterClientOptions private readonly _headers: any = {} constructor (registerClientOptions: RegisterClientOptions) { this._registerClientOptions = registerClientOptions this._headers = this._registerClientOptions.peertubeHelpers.getAuthHeader() ?? {} this._headers['content-type'] = 'application/json;charset=UTF-8' } validateOptions = async (channelConfigurationOptions: ChannelConfigurationOptions): Promise => { const propertiesError: ValidationError['properties'] = {} if (channelConfigurationOptions.terms && channelConfigurationOptions.terms.length > channelTermsMaxLength) { propertiesError.terms = [ValidationErrorType.TooLong] } const botConf = channelConfigurationOptions.bot const slowModeDuration = channelConfigurationOptions.slowMode.duration const moderationDelay = channelConfigurationOptions.moderation.delay propertiesError['slowMode.duration'] = [] propertiesError['moderation.delay'] = [] if ( (typeof slowModeDuration !== 'number') || isNaN(slowModeDuration) ) { propertiesError['slowMode.duration'].push(ValidationErrorType.WrongType) } else if ( slowModeDuration < 0 || slowModeDuration > 1000 ) { propertiesError['slowMode.duration'].push(ValidationErrorType.NotInRange) } if ( (typeof moderationDelay !== 'number') || isNaN(moderationDelay) ) { propertiesError['moderation.delay'].push(ValidationErrorType.WrongType) } else if ( moderationDelay < 0 || moderationDelay > 60 ) { propertiesError['moderation.delay'].push(ValidationErrorType.NotInRange) } // If !bot.enabled, we don't have to validate these fields: // The backend will ignore those values. if (botConf.enabled) { propertiesError['bot.nickname'] = [] propertiesError['bot.forbidSpecialChars.tolerance'] = [] if (/[^\p{L}\p{N}\p{Z}_-]/u.test(botConf.nickname ?? '')) { propertiesError['bot.nickname'].push(ValidationErrorType.WrongFormat) } if (botConf.forbidSpecialChars.enabled) { const forbidSpecialCharsTolerance = channelConfigurationOptions.bot.forbidSpecialChars.tolerance if ( (typeof forbidSpecialCharsTolerance !== 'number') || isNaN(forbidSpecialCharsTolerance) ) { propertiesError['bot.forbidSpecialChars.tolerance'].push(ValidationErrorType.WrongType) } else if ( forbidSpecialCharsTolerance < 0 || forbidSpecialCharsTolerance > 10 ) { propertiesError['bot.forbidSpecialChars.tolerance'].push(ValidationErrorType.NotInRange) } } for (const [i, fw] of botConf.forbiddenWords.entries()) { for (const v of fw.entries) { propertiesError[`bot.forbiddenWords.${i}.entries`] = [] if (fw.regexp) { if (v.trim() !== '') { try { // eslint-disable-next-line no-new new RegExp(v) } catch (_) { propertiesError[`bot.forbiddenWords.${i}.entries`] .push(ValidationErrorType.WrongFormat) } } } } } for (const [i, cd] of botConf.commands.entries()) { propertiesError[`bot.commands.${i}.command`] = [] if (/\s+/.test(cd.command)) { propertiesError[`bot.commands.${i}.command`].push(ValidationErrorType.WrongFormat) } } } if (Object.values(propertiesError).find(e => e.length > 0)) { const validationError = new ValidationError( 'ChannelConfigurationOptionsValidationError', await this._registerClientOptions.peertubeHelpers.translate(LOC_VALIDATION_ERROR), propertiesError ) throw validationError } return true } saveOptions = async (channelId: number, channelConfigurationOptions: ChannelConfigurationOptions): Promise => { if (!await this.validateOptions(channelConfigurationOptions)) { throw new Error('Invalid form data') } const response = await fetch( getBaseRoute(this._registerClientOptions) + '/api/configuration/channel/' + encodeURIComponent(channelId), { method: 'POST', headers: this._headers, body: JSON.stringify(channelConfigurationOptions) } ) if (!response.ok) { throw new Error('Failed to save configuration options.') } return response.json() } fetchUserChannels = async (username: string): Promise => { // FIXME: if more than 100 channels, loop (or add a pagination) const channels = await (await fetch( '/api/v1/accounts/' + encodeURIComponent(username) + '/video-channels?start=0&count=100&sort=name', { method: 'GET', headers: this._headers } )).json() if (!channels || !('data' in channels) || !Array.isArray(channels.data)) { throw new Error('Can\'t get the channel list.') } for (const channel of channels.data) { channel.livechatConfigurationUri = '/p/livechat/configuration/channel?channelId=' + encodeURIComponent(channel.id as string | number) // Note: since Peertube v6.0.0, channel.avatar is dropped, and we have to use channel.avatars. // So, if !channel.avatar, we will search a suitable one in channel.avatars, and fill channel.avatar. if (!channel.avatar && channel.avatars && Array.isArray(channel.avatars)) { for (const avatar of channel.avatars) { if (avatar.width === 120) { channel.avatar = avatar break } } } } return channels.data } fetchConfiguration = async (channelId: number): Promise => { const response = await fetch( getBaseRoute(this._registerClientOptions) + '/api/configuration/channel/' + encodeURIComponent(channelId), { method: 'GET', headers: this._headers } ) if (!response.ok) { throw new Error('Can\'t get channel configuration options.') } return response.json() } public async fetchEmojisConfiguration (channelId: number): Promise { const url = getBaseRoute(this._registerClientOptions) + '/api/configuration/channel/emojis/' + encodeURIComponent(channelId) const response = await fetch( url, { method: 'GET', headers: this._headers } ) if (!response.ok) { throw new Error('Can\'t get channel emojis options.') } return response.json() } public async validateEmojisConfiguration (channelEmojis: ChannelEmojis): Promise { const propertiesError: ValidationError['properties'] = {} if (channelEmojis.customEmojis.length > maxEmojisPerChannel) { // This can happen when using the import function. const validationError = new ValidationError( 'ChannelEmojisValidationError', await this._registerClientOptions.peertubeHelpers.translate(LOC_TOO_MANY_ENTRIES), propertiesError ) throw validationError } const seen = new Map() for (const [i, e] of channelEmojis.customEmojis.entries()) { propertiesError[`emojis.${i}.sn`] = [] if (e.sn === '') { propertiesError[`emojis.${i}.sn`].push(ValidationErrorType.Missing) } else if (!/^:?[\w-]+:?$/.test(e.sn)) { // optional ':' at the beggining and at the end propertiesError[`emojis.${i}.sn`].push(ValidationErrorType.WrongFormat) } else if (seen.has(e.sn)) { propertiesError[`emojis.${i}.sn`].push(ValidationErrorType.Duplicate) } else { seen.set(e.sn, true) } propertiesError[`emojis.${i}.url`] = [] if (!e.url) { propertiesError[`emojis.${i}.url`].push(ValidationErrorType.Missing) } } if (Object.values(propertiesError).find(e => e.length > 0)) { const validationError = new ValidationError( 'ChannelEmojisValidationError', await this._registerClientOptions.peertubeHelpers.translate(LOC_VALIDATION_ERROR), propertiesError ) throw validationError } return true } public async saveEmojisConfiguration ( channelId: number, channelEmojis: ChannelEmojis ): Promise { if (!await this.validateEmojisConfiguration(channelEmojis)) { throw new Error('Invalid form data') } // Note: API request body size is limited to 100Kb (expressjs body-parser defaut limit, and Peertube nginx config). // So we must send new emojis 1 by 1, to be sure to not reach the limit. if (!channelEmojis.customEmojis.find(e => e.url.startsWith('data:'))) { // No new emojis, just saving. return this._saveEmojisConfiguration(channelId, channelEmojis) } let lastResult: ChannelEmojisConfiguration | undefined let customEmojis: CustomEmojiDefinition[] = [...channelEmojis.customEmojis] // copy the original array let i = customEmojis.findIndex(e => e.url.startsWith('data:')) let watchDog = 0 while (i >= 0) { watchDog++ if (watchDog > channelEmojis.customEmojis.length + 10) { // just to avoid infinite loop throw new Error('Seems we have sent too many emojis, this was not expected') } const data: CustomEmojiDefinition[] = customEmojis.slice(0, i + 1) // all elements until first new file data.push( // all remaining elements that where already uploaded (to not loose them): ...customEmojis.slice(i + 1).filter((e) => !e.url.startsWith('data:')) ) lastResult = await this._saveEmojisConfiguration(channelId, { customEmojis: data }) // Must inject the result in customEmojis const temp = lastResult.emojis.customEmojis.slice(0, i + 1) // last element should have been replace by a http url temp.push( ...customEmojis.slice(i + 1) // remaining elements in the previous array ) customEmojis = temp // and searching again next new emojis i = customEmojis.findIndex(e => e.url.startsWith('data:')) } if (!lastResult) { // This should not happen... throw new Error('Unexpected: no last result') } return lastResult } private async _saveEmojisConfiguration ( channelId: number, channelEmojis: ChannelEmojis ): Promise { const url = getBaseRoute(this._registerClientOptions) + '/api/configuration/channel/emojis/' + encodeURIComponent(channelId) const response = await fetch( url, { method: 'POST', headers: this._headers, body: JSON.stringify(channelEmojis) } ) if (!response.ok) { throw new Error('Can\'t get channel emojis options.') } return response.json() } public async enableEmojisOnlyModeOnAllRooms (channelId: number): Promise { const url = getBaseRoute(this._registerClientOptions) + '/api/configuration/channel/emojis/' + encodeURIComponent(channelId) + '/enable_emoji_only' const response = await fetch( url, { method: 'POST', headers: this._headers } ) if (!response.ok) { throw new Error('Can\'t enable Emojis Only Mode on all rooms.') } return response.json() } }