peertube-plugin-livechat/conversejs/builtin.ts

174 lines
6.5 KiB
TypeScript
Raw Normal View History

import type { InitConverseJSParams } 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 } from './lib/auth'
import { randomNick } from './lib/nick'
declare global {
interface Window {
converse: {
initialize: (args: any) => void
plugins: {
add: (name: string, plugin: any) => void
}
}
initConverse: (args: InitConverseJSParams) => Promise<void>
2021-05-03 18:37:23 +00:00
}
}
window.initConverse = async function initConverse (initConverseParams: InitConverseJSParams): 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)
const params = defaultConverseParams(initConverseParams, isInIframe)
2021-05-05 16:16:59 +00:00
2021-05-05 16:35:28 +00:00
let isAuthenticated: boolean = false
let isRemoteWithNicknameSet: boolean = false
2023-01-11 17:05:18 +00:00
const auth = await getLocalAuthentInfos(authenticationUrl)
2023-01-11 17:05:18 +00:00
if (auth) {
if (!isRemoteChat) {
localRoomAuthenticatedParams(initConverseParams, auth, params)
isAuthenticated = true
} else if (remoteAuthenticatedXMPPServer) {
remoteRoomAuthenticatedParams(initConverseParams, auth, params)
isAuthenticated = true
} else if (remoteAnonymousXMPPServer) {
// remote server does not allow remote authenticated users, falling back to anonymous mode
remoteRoomAnonymousParams(initConverseParams, auth, params)
isRemoteWithNicknameSet = true
} else {
throw new Error('Remote server does not allow remote connection')
}
} else {
if (!isRemoteChat) {
localRoomAnonymousParams(initConverseParams, params)
} else if (remoteAnonymousXMPPServer) {
remoteRoomAnonymousParams(initConverseParams, null, params)
} else {
throw new Error('Remote server does not allow remote connection')
}
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
}
try {
converse.plugins.add('livechatWindowTitlePlugin', {
dependencies: ['converse-muc-views'],
overrides: {
ChatRoomView: {
requestUpdate: function (this: any): any {
console.log('[livechatWindowTitlePlugin] updating the document title.')
try {
2022-01-04 16:49:41 +00:00
if (this.model?.getDisplayName) {
const title = this.model.getDisplayName()
if (document.title !== title) {
document.title = title
}
}
} catch (err) {
console.error('[livechatWindowTitlePlugin] Failed updating the window title', err)
}
return this.__super__.requestUpdate.apply(this)
}
}
}
})
2022-01-07 18:20:28 +00:00
if (autoViewerMode && !isAuthenticated && !isRemoteWithNicknameSet) {
converse.plugins.add('livechatViewerModePlugin', {
2022-01-07 18:20:28 +00:00
dependencies: ['converse-muc', 'converse-muc-views'],
initialize: function () {
const _converse = this._converse
const getDefaultMUCNickname = _converse.getDefaultMUCNickname
if (!getDefaultMUCNickname) {
console.error('[livechatViewerModePlugin] getDefaultMUCNickname is not initialized.')
} else {
Object.assign(_converse, {
getDefaultMUCNickname: function (this: any): any {
2022-01-10 02:06:16 +00:00
return getDefaultMUCNickname.apply(this, arguments) ?? randomNick('Anonymous')
2022-01-07 18:20:28 +00:00
}
})
}
_converse.api.settings.update({
livechat_viewer_mode: true
})
function refreshViewerMode (canChat: boolean): void {
console.log('[livechatViewerModePlugin] refreshViewerMode: ' + (canChat ? 'off' : 'on'))
if (canChat) {
document.querySelector('body')?.setAttribute('livechat-viewer-mode', 'off')
2022-01-07 18:20:28 +00:00
} else {
document.querySelector('body')?.setAttribute('livechat-viewer-mode', 'on')
2022-01-07 18:20:28 +00:00
}
}
_converse.api.listen.on('livechatViewerModeSetNickname', () => refreshViewerMode(true))
_converse.api.listen.on('chatRoomInitialized', function (this: any, model: any): void {
const nick = model?.get ? model.get('nick') : ''
refreshViewerMode(nick && !/^Anonymous /.test(nick))
})
}
})
}
// The following code does not work. Just keeping it in case we want to investigate.
// if (authenticationUrl !== '') {
// // We are in builtin-prosody mode. I'll try to disconnect from the room
// // on page unload. This is to avoid some bugs:
// // - users are not show as disconnected until a long timeout
// // - anonymous users' nicknames are not available before this timeout
// // - logged in users sometimes can't switch between iframe and fullscreen more than 1 time
// converse.plugins.add('livechatDisconnectOnUnloadPlugin', {
// initialize: function () {
// const _converse = this._converse
// const { unloadevent } = _converse
// // eslint-disable-next-line @typescript-eslint/no-misused-promises
// window.addEventListener(unloadevent, async () => {
// console.log('[livechatDisconnectOnUnloadPlugin] Disconnecting...')
// await _converse.api.user.logout()
// }, { once: true, passive: true })
// }
// })
// }
converse.initialize(params)
} catch (error) {
console.error('Failed initializing converseJS', error)
}
}