Work in progress: builtin converseJS.

This commit is contained in:
John Livingston 2021-02-20 18:31:21 +01:00
parent 7f5d955cb0
commit fbfb38392d
2 changed files with 249 additions and 179 deletions

View File

@ -1,5 +1,6 @@
'use strict' 'use strict'
function register ({ registerHook, peertubeHelpers }) {
const logger = { const logger = {
log: (s) => console.log('[peertube-plugin-livechat] ' + s), log: (s) => console.log('[peertube-plugin-livechat] ' + s),
info: (s) => console.info('[peertube-plugin-livechat] ' + s), info: (s) => console.info('[peertube-plugin-livechat] ' + s),
@ -24,21 +25,38 @@ function parseUUIDs (s) {
return a.filter(line => line !== '') return a.filter(line => line !== '')
} }
function getBaseRoute () {
// FIXME: should be provided by PeertubeHelpers (does not exists for now)
return '/plugins/livechat/router'
}
function getIframeUri (uuid) { function getIframeUri (uuid) {
if (!settings) { if (!settings) {
logger.error('Settings are not initialized, too soon to compute the iframeUri') logger.error('Settings are not initialized, too soon to compute the iframeUri')
return null return null
} }
let iframeUri = settings['chat-uri'] || '' let iframeUri = ''
if (iframeUri === '') { if (!settings['chat-use-builtin']) {
logger.error('No iframe uri') iframeUri = settings['chat-uri'] || ''
return null
}
iframeUri = iframeUri.replace('{{VIDEO_UUID}}', uuid) iframeUri = iframeUri.replace('{{VIDEO_UUID}}', uuid)
if (!/^https?:\/\//.test(iframeUri)) { if (!/^https?:\/\//.test(iframeUri)) {
logger.error('The webchaturi must begin with https://') logger.error('The webchaturi must begin with https://')
return null return null
} }
} else {
// Using the builtin converseJS
// FIXME: with Peertube 3.0.1 there is no loadByIdOrUUID method,
// we need to pass the complete url.
const video = videoCache[uuid]
if (video) {
const url = video.originInstanceUrl + '/videos/watch/' + uuid
iframeUri = getBaseRoute() + '/webchat?url=' + encodeURIComponent(url)
}
}
if (iframeUri === '') {
logger.error('No iframe uri')
return null
}
return iframeUri return iframeUri
} }
@ -57,7 +75,7 @@ function displayButton (buttons, name, label, callback) {
function displayChatButtons (peertubeHelpers, uuid) { function displayChatButtons (peertubeHelpers, uuid) {
logger.log('Adding buttons in the DOM...') logger.log('Adding buttons in the DOM...')
const p = new Promise((resolve) => { const p = new Promise((resolve, reject) => {
Promise.all([ Promise.all([
peertubeHelpers.translate('Open chat'), peertubeHelpers.translate('Open chat'),
peertubeHelpers.translate('Open chat in a new window'), peertubeHelpers.translate('Open chat in a new window'),
@ -68,9 +86,13 @@ function displayChatButtons (peertubeHelpers, uuid) {
const labelClose = labels[2] const labelClose = labels[2]
const buttons = document.querySelector('.video-actions') const buttons = document.querySelector('.video-actions')
const iframeUri = getIframeUri(uuid)
if (!iframeUri) {
return reject(new Error('No uri, cant display the buttons.'))
}
displayButton(buttons, 'openblank', labelOpenBlank, () => { displayButton(buttons, 'openblank', labelOpenBlank, () => {
closeChat() closeChat()
window.open(getIframeUri(uuid)) window.open(iframeUri)
}) })
displayButton(buttons, 'open', labelOpen, () => openChat()) displayButton(buttons, 'open', labelOpen, () => openChat())
displayButton(buttons, 'close', labelClose, () => closeChat()) displayButton(buttons, 'close', labelClose, () => closeChat())
@ -141,7 +163,7 @@ function closeChat () {
toggleShowHideButtons(false) toggleShowHideButtons(false)
} }
function initChat (peertubeHelpers) { function initChat () {
const el = document.querySelector('#videojs-wrapper') const el = document.querySelector('#videojs-wrapper')
if (!el) { if (!el) {
logger.error('The required div is not present in the DOM.') logger.error('The required div is not present in the DOM.')
@ -159,11 +181,6 @@ function initChat (peertubeHelpers) {
const liveOn = !!settings['chat-all-lives'] const liveOn = !!settings['chat-all-lives']
const nonLiveOn = !!settings['chat-all-non-lives'] const nonLiveOn = !!settings['chat-all-non-lives']
const uuids = parseUUIDs(settings['chat-videos-list']) const uuids = parseUUIDs(settings['chat-videos-list'])
const iframeUri = settings['chat-uri'] || ''
if (iframeUri === '') {
logger.log('no uri, can\'t add chat.')
return
}
if (!uuids.length && !liveOn && !nonLiveOn) { if (!uuids.length && !liveOn && !nonLiveOn) {
logger.log('not activated.') logger.log('not activated.')
return return
@ -197,7 +214,6 @@ function initChat (peertubeHelpers) {
}) })
} }
function register ({ registerHook, peertubeHelpers }) {
registerHook({ registerHook({
target: 'filter:api.video-watch.video.get.result', target: 'filter:api.video-watch.video.get.result',
handler: (video) => { handler: (video) => {
@ -208,7 +224,7 @@ function register ({ registerHook, peertubeHelpers }) {
// FIXME: this should be made in action:video-watch.video.loaded. // FIXME: this should be made in action:video-watch.video.loaded.
// But with Peertube 3.0.1, this hook is not called for lives // But with Peertube 3.0.1, this hook is not called for lives
// in WAITING_FOR_LIVE and LIVE_ENDED states. // in WAITING_FOR_LIVE and LIVE_ENDED states.
initChat(peertubeHelpers) initChat()
return video return video
} }
}) })
@ -216,7 +232,7 @@ function register ({ registerHook, peertubeHelpers }) {
// registerHook({ // registerHook({
// target: 'action:video-watch.video.loaded', // target: 'action:video-watch.video.loaded',
// handler: () => { // handler: () => {
// initChat(peertubeHelpers) // initChat()
// } // }
// }) // })
} }

60
main.js
View File

@ -5,7 +5,9 @@ async function register ({
_storageManager, _storageManager,
_videoCategoryManager, _videoCategoryManager,
_videoLicenceManager, _videoLicenceManager,
_videoLanguageManager _videoLanguageManager,
getRouter,
peertubeHelpers
}) { }) {
registerSetting({ registerSetting({
name: 'chat-auto-display', name: 'chat-auto-display',
@ -41,16 +43,39 @@ async function register ({
'Don\'t add private videos, the UUIDs will be send to frontend.', 'Don\'t add private videos, the UUIDs will be send to frontend.',
private: false private: false
}) })
registerSetting({
name: 'chat-use-builtin',
label: 'Use builtin ConverseJS',
type: 'input-checkbox',
default: true,
private: false,
descriptionHTML: 'If checked, use a builtin ConverseJS iframe.<br>' +
'You still have to configure an external XMPP service. Please see the documentation.'
})
registerSetting({
name: 'chat-bosh-uri',
label: 'Builtin webchat: BOSH uri',
type: 'input',
default: true,
descriptionHTML: 'When using the built-in converseJS webchat:<br>' +
'URI of the external BOSH server. Please make sure it accept cross origin request from your domain.',
private: true
})
registerSetting({ registerSetting({
name: 'chat-uri', name: 'chat-uri',
label: 'Webchat url', label: 'Webchat url',
type: 'input', type: 'input',
default: '', default: '',
descriptionHTML: 'The webchat url. An iframe will be created pointing to this url. ' + descriptionHTML: '<b>If you dont want to use the builtin ConverseJS webchat:</b><br>' +
'Put here your webchat url. An iframe will be created pointing to this url. ' +
'The placeholder {{VIDEO_UUID}} will be replace by the video UUID if present. ' + 'The placeholder {{VIDEO_UUID}} will be replace by the video UUID if present. ' +
'Example : https://my_domain/conversejs.html?room=video_{{VIDEO_UUID}}.', 'Example : https://my_domain/conversejs.html?room=video_{{VIDEO_UUID}}.<br>' +
'If this field is empty, it will use the builtin ConverseJS webchat.',
private: false private: false
}) })
registerSetting({ registerSetting({
name: 'chat-style', name: 'chat-style',
label: 'Webchat iframe style attribute', label: 'Webchat iframe style attribute',
@ -60,6 +85,35 @@ async function register ({
'Example: height:400px;', 'Example: height:400px;',
private: false private: false
}) })
const router = getRouter()
router.get('/ping', (req, res) => res.json({ message: 'pong' }))
router.get('/webchat', async (req, res, next) => {
try {
// FIXME: with Peertube 3.0.1 the following method is not available...
// When loadByIdOrUUID is available, change the entry point to
// be /webchat/:videoId
// const id = req.param('videoId')
// const video = await peertubeHelpers.videos.loadByIdOrUUID(id)
let url = req.query.url
if (!url) {
throw new Error('Missing url parameter)')
}
let video = await peertubeHelpers.videos.loadByUrl(url)
if (!video) {
// FIXME: remove this when loadByIdOrUUID will be available...
// This is a dirty Hack for dev environnements...
url = url.replace(/^https:/, 'http:')
video = await peertubeHelpers.videos.loadByUrl(url)
}
if (!video) {
throw new Error('Video not found')
}
res.send('ok')
} catch (error) {
return next(error)
}
})
} }
async function unregister () { async function unregister () {