peertube-plugin-livechat/server/lib/routers/webchat.ts

382 lines
14 KiB
TypeScript
Raw Normal View History

import type { RegisterServerOptions, MVideoThumbnail } from '@peertube/peertube-types'
import type { Router, Request, Response, NextFunction } from 'express'
2021-11-18 10:08:12 +00:00
import type {
ProsodyListRoomsResult, ProsodyListRoomsResultRoom
2021-11-18 10:08:12 +00:00
} from '../../../shared/lib/types'
import { createProxyServer } from 'http-proxy'
import {
RegisterServerOptionsV5, getBaseRouterRoute, getBaseWebSocketRoute, getBaseStaticRoute, isUserAdmin
} from '../helpers'
2021-05-03 18:37:23 +00:00
import { asyncMiddleware } from '../middlewares/async'
import { getProsodyDomain } from '../prosody/config/domain'
2021-06-12 01:52:45 +00:00
import { getAPIKey } from '../apikey'
2021-08-05 16:25:27 +00:00
import { getChannelInfosById, getChannelNameById } from '../database/channel'
import { isAutoColorsAvailable, areAutoColorsValid, AutoColors } from '../../../shared/lib/autocolors'
import * as path from 'path'
2021-06-12 01:52:45 +00:00
const got = require('got')
const fs = require('fs').promises
interface ProsodyProxyInfo {
host: string
port: string
}
let currentProsodyProxyInfo: ProsodyProxyInfo | null = null
let currentHttpBindProxy: ReturnType<typeof createProxyServer> | null = null
2022-08-24 15:55:24 +00:00
let currentWebsocketProxy: ReturnType<typeof createProxyServer> | null = null
async function initWebchatRouter (options: RegisterServerOptionsV5): Promise<Router> {
const {
getRouter,
registerWebSocketRoute,
peertubeHelpers,
settingsManager
} = options
2021-04-09 17:29:44 +00:00
const converseJSIndex = await fs.readFile(path.resolve(__dirname, '../../conversejs/index.html'))
const router: Router = getRouter()
// eslint-disable-next-line @typescript-eslint/no-misused-promises
2021-08-05 16:25:27 +00:00
router.get('/room/:roomKey', asyncMiddleware(
2021-05-03 18:37:23 +00:00
async (req: Request, res: Response, _next: NextFunction): Promise<void> => {
res.removeHeader('X-Frame-Options') // this route can be opened in an iframe
2021-08-05 16:25:27 +00:00
const roomKey = req.params.roomKey
const settings = await settingsManager.getSettings([
2021-11-18 10:08:12 +00:00
'prosody-room-type',
'disable-websocket',
'converse-theme', 'converse-autocolors'
])
const boshUri = getBaseRouterRoute(options) + 'http-bind'
let wsUri = settings['disable-websocket']
? undefined
: getBaseWebSocketRoute(options) // can be undefined
wsUri = wsUri !== undefined ? wsUri + 'xmpp-websocket' : ''
2021-04-14 16:47:23 +00:00
let room: string
2022-01-07 18:20:28 +00:00
let autoViewerMode: boolean = false
let forceReadonly: 'true' | 'false' | 'noscroll' = 'false'
2021-11-18 10:08:12 +00:00
let converseJSTheme: string = settings['converse-theme'] as string
let transparent: boolean = false
2021-11-18 10:08:12 +00:00
if (!/^\w+$/.test(converseJSTheme)) {
converseJSTheme = 'peertube'
}
const prosodyDomain = await getProsodyDomain(options)
const jid = 'anon.' + prosodyDomain
if (req.query.forcetype === '1') {
// We come from the room list in the settings page.
// Here we don't read the prosody-room-type settings,
// but use the roomKey format.
// NB: there is no extra security. Any user can add this parameter.
// This is not an issue: the setting will be tested at the room creation.
// No room can be created in the wrong mode.
if (/^channel\.\d+$/.test(roomKey)) {
room = 'channel.{{CHANNEL_ID}}@room.' + prosodyDomain
} else {
room = '{{VIDEO_UUID}}@room.' + prosodyDomain
}
} else {
if (settings['prosody-room-type'] === 'channel') {
room = 'channel.{{CHANNEL_ID}}@room.' + prosodyDomain
2022-01-07 18:20:28 +00:00
} else {
room = '{{VIDEO_UUID}}@room.' + prosodyDomain
2021-04-14 16:47:23 +00:00
}
}
2023-01-11 17:05:18 +00:00
const authenticationUrl = options.peertubeHelpers.config.getWebserverUrl() +
getBaseRouterRoute(options) +
'api/auth'
if (req.query._readonly === 'true') {
forceReadonly = 'true'
} else if (req.query._readonly === 'noscroll') {
forceReadonly = 'noscroll'
2021-04-14 16:47:23 +00:00
} else {
autoViewerMode = true // auto join the chat in viewer mode, if not logged in
}
if (req.query._transparent === 'true') {
transparent = true
}
2021-08-05 16:25:27 +00:00
let video: MVideoThumbnail | undefined
let channelId: number
const channelMatches = roomKey.match(/^channel\.(\d+)$/)
if (channelMatches?.[1]) {
channelId = parseInt(channelMatches[1])
// Here we are on a channel room...
2021-08-05 16:25:27 +00:00
const channelInfos = await getChannelInfosById(options, channelId)
if (!channelInfos) {
throw new Error('Channel not found')
}
channelId = channelInfos.id
} else {
const uuid = roomKey // must be a video UUID.
video = await peertubeHelpers.videos.loadByIdOrUUID(uuid)
if (!video) {
throw new Error('Video not found')
}
channelId = video.channelId
}
let page = '' + (converseJSIndex as string)
const baseStaticUrl = getBaseStaticRoute(options)
page = page.replace(/{{BASE_STATIC_URL}}/g, baseStaticUrl)
page = page.replace(/{{JID}}/g, jid)
// Computing the room name...
2021-08-05 16:25:27 +00:00
if (room.includes('{{VIDEO_UUID}}')) {
if (!video) {
throw new Error('Missing video')
}
room = room.replace(/{{VIDEO_UUID}}/g, video.uuid)
}
room = room.replace(/{{CHANNEL_ID}}/g, `${channelId}`)
2021-08-04 15:32:47 +00:00
if (room.includes('{{CHANNEL_NAME}}')) {
2021-08-05 16:25:27 +00:00
const channelName = await getChannelNameById(options, channelId)
if (channelName === null) {
throw new Error('Channel not found')
}
if (!/^[a-zA-Z0-9_.]+$/.test(channelName)) {
// FIXME: see if there is a response here https://github.com/Chocobozzz/PeerTube/issues/4301 for allowed chars
peertubeHelpers.logger.error(`Invalid channel name, contains unauthorized chars: '${channelName}'`)
throw new Error('Invalid channel name, contains unauthorized chars')
}
room = room.replace(/{{CHANNEL_NAME}}/g, channelName)
}
let autocolorsStyles = ''
if (
settings['converse-autocolors'] &&
isAutoColorsAvailable(settings['converse-theme'] as string)
) {
peertubeHelpers.logger.debug('Trying to load AutoColors...')
const autocolors: AutoColors = {
mainForeground: req.query._ac_mainForeground?.toString() ?? '',
mainBackground: req.query._ac_mainBackground?.toString() ?? '',
greyForeground: req.query._ac_greyForeground?.toString() ?? '',
greyBackground: req.query._ac_greyBackground?.toString() ?? '',
menuForeground: req.query._ac_menuForeground?.toString() ?? '',
menuBackground: req.query._ac_menuBackground?.toString() ?? '',
inputForeground: req.query._ac_inputForeground?.toString() ?? '',
inputBackground: req.query._ac_inputBackground?.toString() ?? '',
buttonForeground: req.query._ac_buttonForeground?.toString() ?? '',
buttonBackground: req.query._ac_buttonBackground?.toString() ?? '',
link: req.query._ac_link?.toString() ?? '',
linkHover: req.query._ac_linkHover?.toString() ?? ''
}
if (!Object.values(autocolors).find(c => c !== '')) {
peertubeHelpers.logger.debug('All AutoColors are empty.')
} else {
const autoColorsTest = areAutoColorsValid(autocolors)
if (autoColorsTest === true) {
autocolorsStyles = `
<style>
:root {
--peertube-main-foreground: ${autocolors.mainForeground};
--peertube-main-background: ${autocolors.mainBackground};
--peertube-grey-foreground: ${autocolors.greyForeground};
--peertube-grey-background: ${autocolors.greyBackground};
--peertube-menu-foreground: ${autocolors.menuForeground};
--peertube-menu-background: ${autocolors.menuBackground};
--peertube-input-foreground: ${autocolors.inputForeground};
--peertube-input-background: ${autocolors.inputBackground};
--peertube-button-foreground: ${autocolors.buttonForeground};
--peertube-button-background: ${autocolors.buttonBackground};
--peertube-link: ${autocolors.link};
--peertube-link-hover: ${autocolors.linkHover};
}
</style>
`
} else {
peertubeHelpers.logger.error('Provided AutoColors are invalid.', autoColorsTest)
}
}
} else {
peertubeHelpers.logger.debug('No AutoColors.')
}
// ... then inject it in the page.
page = page.replace(/{{ROOM}}/g, room)
2021-04-14 16:47:23 +00:00
page = page.replace(/{{BOSH_SERVICE_URL}}/g, boshUri)
page = page.replace(/{{WS_SERVICE_URL}}/g, wsUri)
page = page.replace(/{{AUTHENTICATION_URL}}/g, authenticationUrl)
2022-01-07 18:20:28 +00:00
page = page.replace(/{{AUTOVIEWERMODE}}/g, autoViewerMode ? 'true' : 'false')
2021-11-18 10:08:12 +00:00
page = page.replace(/{{CONVERSEJS_THEME}}/g, converseJSTheme)
page = page.replace(/{{CONVERSEJS_AUTOCOLORS}}/g, autocolorsStyles)
page = page.replace(/{{FORCEREADONLY}}/g, forceReadonly)
page = page.replace(/{{TRANSPARENT}}/g, transparent ? 'true' : 'false')
res.status(200)
res.type('html')
res.send(page)
}
2021-05-03 18:37:23 +00:00
))
2022-08-24 09:03:29 +00:00
await disableProxyRoute(options)
2022-08-25 10:31:45 +00:00
router.post('/http-bind',
2021-04-16 11:44:24 +00:00
(req: Request, res: Response, next: NextFunction) => {
try {
if (!currentHttpBindProxy) {
res.status(404)
res.send('Not found')
return
}
req.url = 'http-bind'
currentHttpBindProxy.web(req, res)
} catch (err) {
next(err)
}
2021-04-16 11:44:24 +00:00
}
)
2022-08-25 10:31:45 +00:00
// Peertube >=5.0.0: Adding the websocket route.
if (registerWebSocketRoute) {
registerWebSocketRoute({
route: '/xmpp-websocket',
handler: (request, socket, head) => {
if (!currentWebsocketProxy) {
throw new Error('There is no current websocket proxy, should not get here.')
2022-08-25 10:31:45 +00:00
}
currentWebsocketProxy.ws(request, socket, head)
2022-08-24 15:55:24 +00:00
}
})
}
2021-06-12 01:52:45 +00:00
router.get('/prosody-list-rooms', asyncMiddleware(
async (req: Request, res: Response, _next: NextFunction) => {
if (!res.locals.authenticated) {
res.sendStatus(403)
return
}
if (!await isUserAdmin(options, res)) {
res.sendStatus(403)
return
}
if (!currentProsodyProxyInfo) {
2021-06-12 01:52:45 +00:00
throw new Error('It seems that prosody is not binded... Cant list rooms.')
}
const apiUrl = `http://localhost:${currentProsodyProxyInfo.port}/peertubelivechat_list_rooms/list-rooms`
2021-06-12 01:52:45 +00:00
peertubeHelpers.logger.debug('Calling list rooms API on url: ' + apiUrl)
const rooms = await got(apiUrl, {
method: 'GET',
headers: {
authorization: 'Bearer ' + await getAPIKey(options),
host: currentProsodyProxyInfo.host
2021-06-12 01:52:45 +00:00
},
responseType: 'json',
resolveBodyOnly: true
})
2021-08-05 16:25:27 +00:00
if (Array.isArray(rooms)) {
for (let i = 0; i < rooms.length; i++) {
const room: ProsodyListRoomsResultRoom = rooms[i]
const matches = room.localpart.match(/^channel\.(\d+)$/)
if (matches?.[1]) {
const channelId = parseInt(matches[1])
const channelInfos = await getChannelInfosById(options, channelId)
if (channelInfos) {
room.channel = {
id: channelInfos.id,
name: channelInfos.name,
displayName: channelInfos.displayName
}
}
}
}
}
2021-06-12 01:52:45 +00:00
res.status(200)
const r: ProsodyListRoomsResult = {
ok: true,
rooms: rooms
}
res.json(r)
}
))
2021-04-09 17:29:44 +00:00
return router
}
2022-08-24 09:03:29 +00:00
async function disableProxyRoute ({ peertubeHelpers }: RegisterServerOptions): Promise<void> {
// Note: I tried to promisify the httpbind proxy closing (by waiting for the callback call).
// But this seems to never happen, and stucked the plugin uninstallation.
// So I don't wait.
try {
currentProsodyProxyInfo = null
if (currentHttpBindProxy) {
2022-08-24 15:55:24 +00:00
peertubeHelpers.logger.info('Closing the http bind proxy...')
currentHttpBindProxy.close()
2022-08-24 09:03:29 +00:00
currentHttpBindProxy = null
}
2022-08-24 15:55:24 +00:00
if (currentWebsocketProxy) {
peertubeHelpers.logger.info('Closing the websocket proxy...')
currentWebsocketProxy.close()
currentWebsocketProxy = null
}
} catch (err) {
peertubeHelpers.logger.error('Seems that the http bind proxy close has failed: ' + (err as string))
}
}
2022-08-24 09:03:29 +00:00
async function enableProxyRoute (
{ peertubeHelpers }: RegisterServerOptions,
prosodyProxyInfo: ProsodyProxyInfo
2022-08-24 09:03:29 +00:00
): Promise<void> {
const logger = peertubeHelpers.logger
if (!/^\d+$/.test(prosodyProxyInfo.port)) {
logger.error(`Port '${prosodyProxyInfo.port}' is not valid. Aborting.`)
return
}
currentProsodyProxyInfo = prosodyProxyInfo
logger.info('Creating a new http bind proxy')
currentHttpBindProxy = createProxyServer({
target: 'http://localhost:' + prosodyProxyInfo.port + '/http-bind',
ignorePath: true
})
currentHttpBindProxy.on('error', (err, req, res) => {
// We must handle errors, otherwise Peertube server crashes!
logger.error(
2022-08-24 15:55:24 +00:00
'The http bind proxy got an error ' +
'(this can be normal if you updated/uninstalled the plugin, or shutdowned peertube while users were chatting): ' +
err.message
)
if ('writeHead' in res) {
res.writeHead(500)
}
res.end('')
})
currentHttpBindProxy.on('close', () => {
logger.info('Got a close event for the http bind proxy')
})
2022-08-24 15:55:24 +00:00
logger.info('Creating a new websocket proxy')
currentWebsocketProxy = createProxyServer({
target: 'http://localhost:' + prosodyProxyInfo.port + '/xmpp-websocket',
ignorePath: true,
ws: true
})
currentWebsocketProxy.on('error', (err, req, res) => {
// We must handle errors, otherwise Peertube server crashes!
logger.error(
'The websocket proxy got an error ' +
'(this can be normal if you updated/uninstalled the plugin, or shutdowned peertube while users were chatting): ' +
err.message
2022-08-24 15:55:24 +00:00
)
if ('writeHead' in res) {
res.writeHead(500)
}
res.end('')
})
currentWebsocketProxy.on('close', () => {
logger.info('Got a close event for the websocket proxy')
})
}
2021-04-09 17:29:44 +00:00
export {
initWebchatRouter,
disableProxyRoute,
enableProxyRoute
}