peertube-plugin-livechat/conversejs/builtin.ts

240 lines
8.8 KiB
TypeScript
Raw Normal View History

2024-05-23 09:42:14 +00:00
// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
//
// SPDX-License-Identifier: AGPL-3.0-only
import type { InitConverseJSParams, ChatIncludeMode, ExternalAuthResult } from 'shared/lib/types'
import { inIframe } from './lib/utils'
import { initDom } from './lib/dom'
import {
defaultConverseParams,
localRoomAnonymousParams,
localRoomAuthenticatedParams,
remoteRoomAnonymousParams,
remoteRoomAuthenticatedParams
} from './lib/converse-params'
import { getLocalAuthentInfos, getLivechatTokenAuthInfos } from './lib/auth'
import { randomNick } from './lib/nick'
import { slowModePlugin } from './lib/plugins/slow-mode'
import { windowTitlePlugin } from './lib/plugins/window-title'
import { livechatSpecificsPlugin } from './lib/plugins/livechat-specific'
import { livechatViewerModePlugin } from './lib/plugins/livechat-viewer-mode'
import { livechatMiniMucHeadPlugin } from './lib/plugins/livechat-mini-muc-head'
2024-05-28 15:56:24 +00:00
import { livechatEmojisPlugin } from './lib/plugins/livechat-emojis'
declare global {
interface Window {
converse: {
initialize: (args: any) => void
plugins: {
add: (name: string, plugin: any) => void
}
2024-05-28 15:56:24 +00:00
emojis: any
livechatDisconnect?: Function
}
initConversePlugins: typeof initConversePlugins
initConverse: typeof initConverse
2024-03-28 11:22:30 +00:00
reconnectConverse?: (room: string) => void
externalAuthGetResult?: (data: ExternalAuthResult) => void
2021-05-03 18:37:23 +00:00
}
}
/**
* Initilialize ConverseJS plugins.
* @param peertubeEmbedded true if we are embedded in Peertube, false if it is the old full page mode.
*/
function initConversePlugins (peertubeEmbedded: boolean): void {
const converse = window.converse
if (!peertubeEmbedded) {
// When in full page mode, this plugin ensure the window title is equal to the room title.
converse.plugins.add('livechatWindowTitlePlugin', windowTitlePlugin)
}
// Slow mode
converse.plugins.add('converse-slow-mode', slowModePlugin)
// livechatSpecifics plugins add some customization for the livechat plugin.
converse.plugins.add('livechatSpecifics', livechatSpecificsPlugin)
2024-05-28 15:56:24 +00:00
// Channels emojis.
converse.plugins.add('livechatEmojis', livechatEmojisPlugin)
if (peertubeEmbedded) {
// This plugins handles some buttons that are generated by Peertube, to include them in the MUC menu.
converse.plugins.add('livechatMiniMucHeadPlugin', livechatMiniMucHeadPlugin)
}
// Viewer mode (anonymous accounts, before they have chosen their nickname).
converse.plugins.add('livechatViewerModePlugin', livechatViewerModePlugin)
}
window.initConversePlugins = initConversePlugins
/**
* Init ConverseJS
* @param initConverseParams ConverseJS init Params
* @param chatIncludeMode How the chat is included in the html page
* @param peertubeAuthHeader when embedded in Peertube, we can get the header from peertubeHelpers
*/
async function initConverse (
2023-12-27 14:51:43 +00:00
initConverseParams: InitConverseJSParams,
chatIncludeMode: ChatIncludeMode = 'chat-only',
peertubeAuthHeader?: { [header: string]: string } | null
2023-12-27 14:51:43 +00:00
): Promise<void> {
// First, fixing relative websocket urls.
if (initConverseParams.localWebsocketServiceUrl?.startsWith('/')) {
initConverseParams.localWebsocketServiceUrl = new URL(
initConverseParams.localWebsocketServiceUrl,
2022-08-24 15:55:24 +00:00
(window.location.protocol === 'http:' ? 'ws://' : 'wss://') + window.location.host
).toString()
}
const {
isRemoteChat,
remoteAnonymousXMPPServer,
remoteAuthenticatedXMPPServer,
authenticationUrl,
autoViewerMode,
forceReadonly
} = initConverseParams
const converse = window.converse
2021-05-03 18:37:23 +00:00
const isInIframe = inIframe()
initDom(initConverseParams, isInIframe)
2024-04-03 09:43:36 +00:00
// Autofocus: false if besides video, or if an external iframe
initConverseParams.autofocus = (chatIncludeMode === 'peertube-fullpage') ||
(chatIncludeMode === 'chat-only' && !isInIframe)
// hide participant if in an external iframe, or besides video.
initConverseParams.forceDefaultHideMucParticipants = (isInIframe || chatIncludeMode === 'peertube-video')
2024-04-02 15:40:43 +00:00
const params = defaultConverseParams(initConverseParams)
params.view_mode = chatIncludeMode === 'chat-only' ? 'fullscreen' : 'embedded'
params.allow_url_history_change = chatIncludeMode === 'chat-only'
2021-05-05 16:16:59 +00:00
2021-05-05 16:35:28 +00:00
let isAuthenticated: boolean = false
let isAuthenticatedWithExternalAccount: boolean = false
let isRemoteWithNicknameSet: boolean = false
2023-01-11 17:05:18 +00:00
// OIDC (OpenID Connect):
const tryOIDC = (initConverseParams.externalAuthOIDC?.length ?? 0) > 0
let auth
let usedLivechatToken = false
if (chatIncludeMode === 'chat-only') {
// In this mode, we can check if there is a token in the url.
auth = getLivechatTokenAuthInfos()
if (auth) { usedLivechatToken = true }
}
auth ??= await getLocalAuthentInfos(authenticationUrl, tryOIDC, peertubeAuthHeader)
2023-01-11 17:05:18 +00:00
if (auth) {
if (!isRemoteChat) {
localRoomAuthenticatedParams(initConverseParams, auth, params)
isAuthenticated = true
isAuthenticatedWithExternalAccount = auth.type !== 'peertube'
} else if (remoteAuthenticatedXMPPServer) {
remoteRoomAuthenticatedParams(initConverseParams, auth, params)
isAuthenticated = true
isAuthenticatedWithExternalAccount = auth.type !== 'peertube'
} else if (remoteAnonymousXMPPServer) {
// remote server does not allow remote authenticated users, falling back to anonymous mode
remoteRoomAnonymousParams(initConverseParams, auth, params)
isRemoteWithNicknameSet = true
} else {
console.error('Remote server does not allow remote connection')
params.jid = null
}
} else {
if (!isRemoteChat) {
localRoomAnonymousParams(initConverseParams, params)
} else if (remoteAnonymousXMPPServer) {
remoteRoomAnonymousParams(initConverseParams, null, params)
} else {
console.error('Remote server does not allow remote connection')
params.jid = null
}
}
if (params.jid === null) {
if (chatIncludeMode === 'chat-only') {
// Special use case: when mode=chat-only, and no params.jid: display an error page.
// Note: this can happen if anonymous users are not allowed on the server.
console.error('Seems that anonymous users are not allowed on the target server')
// FIXME: localize?
document.body.innerHTML = '<h1>This chatroom does not exist, or is not accessible to you.</h1>'
return
} else {
throw new Error('Can\'t connect, no JID')
}
2021-05-03 18:37:23 +00:00
}
2021-05-05 16:35:28 +00:00
if (!isAuthenticated) {
console.log('User is not authenticated.')
if (forceReadonly) {
2022-01-10 02:06:16 +00:00
params.nickname = randomNick('Viewer')
}
2021-05-05 16:35:28 +00:00
// TODO: try to make these params work
2021-08-06 15:52:32 +00:00
// params.muc_nickname_from_jid = true => compute the muc nickname from the jid (will be random here)
// params.auto_register_muc_nickname = true => maybe not relevant here (dont do what i thought)
// params.muc_show_logs_before_join = true => displays muc history on top of nickname form. But it's not updated.
2021-05-05 16:35:28 +00:00
}
// no viewer mode if authenticated.
params.livechat_enable_viewer_mode = autoViewerMode && !isAuthenticated && !isRemoteWithNicknameSet
params.livechat_specific_external_authent = isAuthenticatedWithExternalAccount
if (tryOIDC && !isAuthenticated) {
params.livechat_external_auth_oidc_buttons = initConverseParams.externalAuthOIDC
}
if (tryOIDC) { // also needed when authenticated (for the signout button)
switch (chatIncludeMode) {
case 'peertube-video':
params.livechat_external_auth_reconnect_mode = 'button-close-open'
break
case 'peertube-fullpage':
case 'chat-only':
default:
params.livechat_external_auth_reconnect_mode = 'reload'
}
}
2022-01-07 18:20:28 +00:00
if (chatIncludeMode === 'peertube-video') {
params.livechat_mini_muc_head = true // we must replace the muc-head by the custom buttons toolbar.
}
// We enable task list only if we are in the peertube interface, or if:
// * mode === chat-only + !transparent + !readonly + is using a livechat token
// Technically it would work in 'chat-only' mode, but i don't want to add too many things to test
// (and i now there is some CSS bugs in the task list).
let enableTask = false
if (chatIncludeMode === 'peertube-video' || chatIncludeMode === 'peertube-fullpage') {
enableTask = true
} else if (
chatIncludeMode === 'chat-only' &&
usedLivechatToken &&
!initConverseParams.transparent &&
!initConverseParams.forceReadonly
) {
enableTask = true
}
if (enableTask) {
params.livechat_task_app_enabled = true
params.livechat_task_app_restore = chatIncludeMode === 'peertube-fullpage' || chatIncludeMode === 'chat-only'
}
try {
2024-03-28 11:22:30 +00:00
if (window.reconnectConverse) { // this is set in the livechatSpecificsPlugin
window.reconnectConverse(params)
} else {
converse.initialize(params)
}
} catch (error) {
console.error('Failed initializing converseJS', error)
}
}
window.initConverse = initConverse