Moderation configuration screen: WIP.
This commit is contained in:
parent
efb8710f67
commit
02728bb38d
2
client/@types/global.d.ts
vendored
2
client/@types/global.d.ts
vendored
@ -35,3 +35,5 @@ declare const LOC_MENU_MODERATION_LABEL: string
|
|||||||
declare const LOC_LIVECHAT_MODERATION_TITLE: string
|
declare const LOC_LIVECHAT_MODERATION_TITLE: string
|
||||||
declare const LOC_LIVECHAT_MODERATION_DESC: string
|
declare const LOC_LIVECHAT_MODERATION_DESC: string
|
||||||
declare const LOC_LIVECHAT_MODERATION_PLEASE_SELECT: string
|
declare const LOC_LIVECHAT_MODERATION_PLEASE_SELECT: string
|
||||||
|
declare const LOC_LIVECHAT_MODERATION_CHANNEL_TITLE: string
|
||||||
|
declare const LOC_LIVECHAT_MODERATION_CHANNEL_DESC: string
|
||||||
|
@ -1,6 +1,11 @@
|
|||||||
import type { RegisterClientOptions } from '@peertube/peertube-types/client'
|
import type { RegisterClientOptions } from '@peertube/peertube-types/client'
|
||||||
import { renderModerationHome } from './templates/home'
|
import { renderModerationHome } from './templates/home'
|
||||||
|
import { renderModerationChannel } from './templates/channel'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers stuff related to the moderation settings.
|
||||||
|
* @param clientOptions Peertube client options
|
||||||
|
*/
|
||||||
async function registerModeration (clientOptions: RegisterClientOptions): Promise<void> {
|
async function registerModeration (clientOptions: RegisterClientOptions): Promise<void> {
|
||||||
const { peertubeHelpers, registerClientRoute, registerHook } = clientOptions
|
const { peertubeHelpers, registerClientRoute, registerHook } = clientOptions
|
||||||
|
|
||||||
@ -11,6 +16,15 @@ async function registerModeration (clientOptions: RegisterClientOptions): Promis
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
registerClientRoute({
|
||||||
|
route: 'livechat/moderation/channel',
|
||||||
|
onMount: async ({ rootEl }) => {
|
||||||
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
|
const channelId = urlParams.get('channelId') ?? ''
|
||||||
|
rootEl.innerHTML = await renderModerationChannel(clientOptions, channelId)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
registerHook({
|
registerHook({
|
||||||
target: 'filter:left-menu.links.create.result',
|
target: 'filter:left-menu.links.create.result',
|
||||||
handler: async (links: any) => {
|
handler: async (links: any) => {
|
||||||
|
58
client/common/moderation/templates/channel.ts
Normal file
58
client/common/moderation/templates/channel.ts
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
import type { RegisterClientOptions } from '@peertube/peertube-types/client'
|
||||||
|
import type { ChannelModerationOptions } from 'shared/lib/types'
|
||||||
|
import { getBaseRoute } from '../../../videowatch/uri'
|
||||||
|
// Must use require for mustache, import seems buggy.
|
||||||
|
const Mustache = require('mustache')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Renders the moderation settings page for a given channel.
|
||||||
|
* @param registerClientOptions Peertube client options
|
||||||
|
* @param channelId The channel id
|
||||||
|
* @returns The page content
|
||||||
|
*/
|
||||||
|
async function renderModerationChannel (
|
||||||
|
registerClientOptions: RegisterClientOptions,
|
||||||
|
channelId: string
|
||||||
|
): Promise<string> {
|
||||||
|
const { peertubeHelpers } = registerClientOptions
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (!channelId || !/^\d+$/.test(channelId)) {
|
||||||
|
throw new Error('Missing or invalid channel id.')
|
||||||
|
}
|
||||||
|
|
||||||
|
const channelModerationOptions: ChannelModerationOptions = await (await fetch(
|
||||||
|
getBaseRoute(registerClientOptions) + '/api/moderation/channel/' + encodeURIComponent(channelId),
|
||||||
|
{
|
||||||
|
method: 'GET',
|
||||||
|
headers: peertubeHelpers.getAuthHeader()
|
||||||
|
}
|
||||||
|
)).json()
|
||||||
|
|
||||||
|
// Basic testing that channelModerationOptions has the correct format
|
||||||
|
if ((typeof channelModerationOptions !== 'object') || !channelModerationOptions.channel) {
|
||||||
|
throw new Error('Can\'t get channel moderation options.')
|
||||||
|
}
|
||||||
|
|
||||||
|
const view = {
|
||||||
|
title:
|
||||||
|
await peertubeHelpers.translate(LOC_LIVECHAT_MODERATION_CHANNEL_TITLE) +
|
||||||
|
' ' + channelModerationOptions.channel.displayName,
|
||||||
|
description: await peertubeHelpers.translate(LOC_LIVECHAT_MODERATION_CHANNEL_DESC)
|
||||||
|
}
|
||||||
|
|
||||||
|
return Mustache.render(`
|
||||||
|
<div class="margin-content">
|
||||||
|
<h1>{{title}}</h1>
|
||||||
|
<p>{{description}}</p>
|
||||||
|
</div>
|
||||||
|
`, view) as string
|
||||||
|
} catch (err: any) {
|
||||||
|
peertubeHelpers.notifier.error(err.toString())
|
||||||
|
return ''
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export {
|
||||||
|
renderModerationChannel
|
||||||
|
}
|
@ -2,6 +2,11 @@ import type { RegisterClientOptions } from '@peertube/peertube-types/client'
|
|||||||
// Must use require for mustache, import seems buggy.
|
// Must use require for mustache, import seems buggy.
|
||||||
const Mustache = require('mustache')
|
const Mustache = require('mustache')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Renders the livechat moderation setup home page.
|
||||||
|
* @param registerClientOptions Peertube client options
|
||||||
|
* @returns The page content
|
||||||
|
*/
|
||||||
async function renderModerationHome (registerClientOptions: RegisterClientOptions): Promise<string> {
|
async function renderModerationHome (registerClientOptions: RegisterClientOptions): Promise<string> {
|
||||||
const { peertubeHelpers } = registerClientOptions
|
const { peertubeHelpers } = registerClientOptions
|
||||||
|
|
||||||
@ -24,7 +29,7 @@ async function renderModerationHome (registerClientOptions: RegisterClientOption
|
|||||||
}
|
}
|
||||||
|
|
||||||
for (const channel of channels.data) {
|
for (const channel of channels.data) {
|
||||||
channel.livechatModerationUri = '/p/livechat/moderation/channel?id=' + encodeURIComponent(channel.id)
|
channel.livechatModerationUri = '/p/livechat/moderation/channel?channelId=' + encodeURIComponent(channel.id)
|
||||||
}
|
}
|
||||||
|
|
||||||
const view = {
|
const view = {
|
||||||
@ -34,9 +39,6 @@ async function renderModerationHome (registerClientOptions: RegisterClientOption
|
|||||||
channels: channels.data
|
channels: channels.data
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: remove this line
|
|
||||||
console.log('Rendering the moderation home with view:', view)
|
|
||||||
|
|
||||||
return Mustache.render(`
|
return Mustache.render(`
|
||||||
<div class="margin-content">
|
<div class="margin-content">
|
||||||
<h1>{{title}}</h1>
|
<h1>{{title}}</h1>
|
||||||
|
@ -283,3 +283,5 @@ menu_moderation_label: "Chatrooms"
|
|||||||
livechat_moderation_title: "Configure your live's chatrooms moderation policies"
|
livechat_moderation_title: "Configure your live's chatrooms moderation policies"
|
||||||
livechat_moderation_desc: "Here you can configure some advanced options for chatrooms associated to your live streams."
|
livechat_moderation_desc: "Here you can configure some advanced options for chatrooms associated to your live streams."
|
||||||
livechat_moderation_please_select: "Please select bellow one of your channel, to setup its chatting options."
|
livechat_moderation_please_select: "Please select bellow one of your channel, to setup its chatting options."
|
||||||
|
livechat_moderation_channel_title: "Moderation policies for channel:"
|
||||||
|
livechat_moderation_channel_desc: "You can setup here your moderation policies for this channel."
|
||||||
|
@ -51,6 +51,7 @@ interface ChannelInfos {
|
|||||||
id: number
|
id: number
|
||||||
name: string
|
name: string
|
||||||
displayName: string
|
displayName: string
|
||||||
|
ownerAccountId: number
|
||||||
}
|
}
|
||||||
|
|
||||||
async function getChannelInfosById (options: RegisterServerOptions, channelId: number): Promise<ChannelInfos | null> {
|
async function getChannelInfosById (options: RegisterServerOptions, channelId: number): Promise<ChannelInfos | null> {
|
||||||
@ -64,7 +65,8 @@ async function getChannelInfosById (options: RegisterServerOptions, channelId: n
|
|||||||
'SELECT' +
|
'SELECT' +
|
||||||
' "actor"."preferredUsername" as "channelName",' +
|
' "actor"."preferredUsername" as "channelName",' +
|
||||||
' "videoChannel"."id" as "channelId",' +
|
' "videoChannel"."id" as "channelId",' +
|
||||||
' "videoChannel"."name" as "channelDisplayName"' +
|
' "videoChannel"."name" as "channelDisplayName",' +
|
||||||
|
' "videoChannel"."accountId" as "ownerAccountId"' +
|
||||||
' FROM "videoChannel"' +
|
' FROM "videoChannel"' +
|
||||||
' RIGHT JOIN "actor" ON "actor"."id" = "videoChannel"."actorId"' +
|
' RIGHT JOIN "actor" ON "actor"."id" = "videoChannel"."actorId"' +
|
||||||
' WHERE "videoChannel"."id" = ' + channelId.toString()
|
' WHERE "videoChannel"."id" = ' + channelId.toString()
|
||||||
@ -79,7 +81,8 @@ async function getChannelInfosById (options: RegisterServerOptions, channelId: n
|
|||||||
return {
|
return {
|
||||||
id: results[0].channelId,
|
id: results[0].channelId,
|
||||||
name: results[0].channelName ?? '',
|
name: results[0].channelName ?? '',
|
||||||
displayName: results[0].channelDisplayName ?? ''
|
displayName: results[0].channelDisplayName ?? '',
|
||||||
|
ownerAccountId: results[0].ownerAccountId
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -75,6 +75,20 @@ async function isUserAdmin (options: RegisterServerOptions, res: Response): Prom
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function isUserAdminOrModerator (options: RegisterServerOptions, res: Response): Promise<boolean> {
|
||||||
|
const user = await options.peertubeHelpers.user.getAuthUser(res)
|
||||||
|
if (!user) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if (user.blocked) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if (user.role !== 0 && user.role !== 1) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
type Unpack<T> = T extends Promise<infer U | undefined> ? U : T
|
type Unpack<T> = T extends Promise<infer U | undefined> ? U : T
|
||||||
type AuthUser = Unpack<ReturnType<PeerTubeHelpers['user']['getAuthUser']>>
|
type AuthUser = Unpack<ReturnType<PeerTubeHelpers['user']['getAuthUser']>>
|
||||||
|
|
||||||
@ -95,6 +109,7 @@ export {
|
|||||||
getBaseWebSocketRoute,
|
getBaseWebSocketRoute,
|
||||||
getBaseStaticRoute,
|
getBaseStaticRoute,
|
||||||
isUserAdmin,
|
isUserAdmin,
|
||||||
|
isUserAdminOrModerator,
|
||||||
getUserNickname,
|
getUserNickname,
|
||||||
pluginName,
|
pluginName,
|
||||||
pluginShortName,
|
pluginShortName,
|
||||||
|
@ -7,6 +7,7 @@ import { isDebugMode } from '../debug'
|
|||||||
import { initRoomApiRouter } from './api/room'
|
import { initRoomApiRouter } from './api/room'
|
||||||
import { initAuthApiRouter, initUserAuthApiRouter } from './api/auth'
|
import { initAuthApiRouter, initUserAuthApiRouter } from './api/auth'
|
||||||
import { initFederationServerInfosApiRouter } from './api/federation-server-infos'
|
import { initFederationServerInfosApiRouter } from './api/federation-server-infos'
|
||||||
|
import { initModerationApiRouter } from './api/moderation'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initiate API routes
|
* Initiate API routes
|
||||||
@ -52,6 +53,8 @@ async function initApiRouter (options: RegisterServerOptions): Promise<Router> {
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
router.use('/moderation', await initModerationApiRouter(options))
|
||||||
|
|
||||||
return router
|
return router
|
||||||
}
|
}
|
||||||
|
|
||||||
|
62
server/lib/routers/api/moderation.ts
Normal file
62
server/lib/routers/api/moderation.ts
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
import type { RegisterServerOptions } from '@peertube/peertube-types'
|
||||||
|
import type { Router, Request, Response, NextFunction } from 'express'
|
||||||
|
import type { ChannelModerationOptions } from '../../../../shared/lib/types'
|
||||||
|
import { asyncMiddleware } from '../../middlewares/async'
|
||||||
|
import { getChannelInfosById } from '../../database/channel'
|
||||||
|
import { isUserAdminOrModerator } from '../../helpers'
|
||||||
|
|
||||||
|
async function initModerationApiRouter (options: RegisterServerOptions): Promise<Router> {
|
||||||
|
const router = options.getRouter()
|
||||||
|
const logger = options.peertubeHelpers.logger
|
||||||
|
|
||||||
|
router.get('/channel/:channelId', asyncMiddleware(
|
||||||
|
async (req: Request, res: Response, _next: NextFunction): Promise<void> => {
|
||||||
|
const channelId = req.params.channelId
|
||||||
|
const currentUser = await options.peertubeHelpers.user.getAuthUser(res)
|
||||||
|
|
||||||
|
if (!channelId || !/^\d+$/.test(channelId)) {
|
||||||
|
res.sendStatus(400)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const channelInfos = await getChannelInfosById(options, parseInt(channelId))
|
||||||
|
if (!channelInfos) {
|
||||||
|
logger.warn(`Channel ${channelId} not found`)
|
||||||
|
res.sendStatus(404)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// To access this page, you must either be:
|
||||||
|
// - the channel owner,
|
||||||
|
// - an instance modo/admin
|
||||||
|
// - TODO: a channel chat moderator, as defined in this page.
|
||||||
|
if (channelInfos.ownerAccountId === currentUser.Account.id) {
|
||||||
|
logger.debug('Current user is the channel owner')
|
||||||
|
} else if (await isUserAdminOrModerator(options, res)) {
|
||||||
|
logger.debug('Current user is an instance moderator or admin')
|
||||||
|
} else {
|
||||||
|
logger.warn('Current user tries to access a channel for which he has no right.')
|
||||||
|
res.sendStatus(403)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.debug('User can access the moderation channel api.')
|
||||||
|
|
||||||
|
const result: ChannelModerationOptions = {
|
||||||
|
channel: {
|
||||||
|
id: channelInfos.id,
|
||||||
|
name: channelInfos.name,
|
||||||
|
displayName: channelInfos.displayName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
res.status(200)
|
||||||
|
res.json(result)
|
||||||
|
}
|
||||||
|
))
|
||||||
|
|
||||||
|
return router
|
||||||
|
}
|
||||||
|
|
||||||
|
export {
|
||||||
|
initModerationApiRouter
|
||||||
|
}
|
@ -46,9 +46,18 @@ interface ProsodyListRoomsResultSuccess {
|
|||||||
|
|
||||||
type ProsodyListRoomsResult = ProsodyListRoomsResultError | ProsodyListRoomsResultSuccess
|
type ProsodyListRoomsResult = ProsodyListRoomsResultError | ProsodyListRoomsResultSuccess
|
||||||
|
|
||||||
|
interface ChannelModerationOptions {
|
||||||
|
channel: {
|
||||||
|
id: number
|
||||||
|
name: string
|
||||||
|
displayName: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export type {
|
export type {
|
||||||
ConverseJSTheme,
|
ConverseJSTheme,
|
||||||
InitConverseJSParams,
|
InitConverseJSParams,
|
||||||
ProsodyListRoomsResult,
|
ProsodyListRoomsResult,
|
||||||
ProsodyListRoomsResultRoom
|
ProsodyListRoomsResultRoom,
|
||||||
|
ChannelModerationOptions
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user