Refactoring + new embedded chat:

* moving conversejs plugin in separate files
* disconnecting embedded chat on navigation-end
This commit is contained in:
John Livingston
2024-03-27 16:26:32 +01:00
parent 67a1a6e32d
commit 8988a85ec9
8 changed files with 181 additions and 157 deletions

View File

@ -0,0 +1,56 @@
export const livechatSpecificsPlugin = {
dependencies: ['converse-muc', 'converse-muc-views'],
initialize: function (this: any) {
const _converse = this._converse
_converse.api.listen.on('chatRoomViewInitialized', function (this: any, _model: any): void {
// Remove the spinner if present...
document.getElementById('livechat-loading-spinner')?.remove()
})
// Adding a methode on window.converse, so we can close the chat on navigation-end event
// (when chatIncludeMode is peertube-*)
window.converse.livechatDisconnect = function livechatDisconnect () {
console.log('[livechatSpecificsPlugin] disconnecting converseJS...')
_converse.api.user.logout()
window.converse.livechatDisconnect = undefined // will be set again on next initialize.
}
},
overrides: {
ChatRoom: {
getActionInfoMessage: function (this: any, code: string, nick: string, actor: any): any {
if (code === '303') {
// When there is numerous anonymous users joining at the same time,
// they can all change their nicknames at the same time, generating a log of action messages.
// To mitigate this, will don't display nickname changes if the previous nick is something like
// 'Anonymous 12345'.
if (/^Anonymous \d+$/.test(nick)) {
// To avoid displaying the message, we just have to return an empty one
// (createInfoMessage will ignore if !data.message).
return null
}
}
return this.__super__.getActionInfoMessage(code, nick, actor)
}
},
ChatRoomMessage: {
/* By default, ConverseJS groups messages from the same users for a 10 minutes period.
* This make no sense in a livechat room. So we override isFollowup to ignore. */
isFollowup: function isFollowup () { return false }
},
ChatRoomOccupants: {
comparator: function (this: any, occupant1: any, occupant2: any): Number {
// Overriding Occupants comparators, to display anonymous users at the end of the list.
const nick1: string = occupant1.getDisplayName()
const nick2: string = occupant2.getDisplayName()
const b1 = nick1.startsWith('Anonymous ')
const b2 = nick2.startsWith('Anonymous ')
if (b1 === b2) {
// Both startswith anonymous, or non of it: fallback to the standard comparator.
return this.__super__.comparator(occupant1, occupant2)
}
// Else: Anonymous always last.
return b1 ? 1 : -1
}
}
}
}

View File

@ -0,0 +1,59 @@
import { randomNick, getPreviousAnonymousNick, setPreviousAnonymousNick } from '../nick'
export const livechatViewerModePlugin = {
dependencies: ['converse-muc', 'converse-muc-views'],
initialize: function (this: any) {
const _converse = this._converse
const previousNickname = getPreviousAnonymousNick()
const getDefaultMUCNickname = _converse.getDefaultMUCNickname
if (!getDefaultMUCNickname) {
console.error('[livechatViewerModePlugin] getDefaultMUCNickname is not initialized.')
} else {
Object.assign(_converse, {
getDefaultMUCNickname: function (this: any): any {
return getDefaultMUCNickname.apply(this, arguments) ?? previousNickname ?? randomNick('Anonymous')
}
})
}
function refreshViewerMode (canChat: boolean): void {
console.log('[livechatViewerModePlugin] refreshViewerMode: ' + (canChat ? 'off' : 'on'))
if (canChat) {
document.querySelector('body')?.setAttribute('livechat-viewer-mode', 'off')
} else {
document.querySelector('body')?.setAttribute('livechat-viewer-mode', 'on')
}
}
if (previousNickname === null) {
_converse.api.settings.update({
livechat_viewer_mode: true
})
}
_converse.api.listen.on('livechatViewerModeSetNickname', () => refreshViewerMode(true))
_converse.ChatRoomOccupants.prototype.on('change:nick', (data: any, nick: string) => {
try {
// On nick change, if the user is_me, storing the new nickname
if (nick && data?.attributes?.is_me === true) {
console.log('Nickname change, storing to previousAnonymousNick')
setPreviousAnonymousNick(nick)
}
} catch (err) {
console.error('Error on nick change handling...', err)
}
})
_converse.api.listen.on('chatRoomInitialized', function (this: any, model: any): void {
// When room is initialized, if user has chosen a nickname, set viewermode to off.
// Note: when previousNickname is set, model.get('nick') has not the nick yet...
// It will only come after receiving a presence stanza.
// So we use previousNickname before trying to read the model.
const nick = previousNickname ?? (model?.get ? model.get('nick') : '')
refreshViewerMode(nick && !/^Anonymous /.test(nick))
})
}
}

View File

@ -0,0 +1,21 @@
export const windowTitlePlugin = {
dependencies: ['converse-muc-views'],
overrides: {
ChatRoomView: {
requestUpdate: function (this: any): any {
console.log('[livechatWindowTitlePlugin] updating the document title.')
try {
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)
}
}
}
}