peertube-plugin-livechat/client/videowatch-client-plugin.js
John Livingston a7c6e520e6 Better UX
* All buttons are in the same DOM container as the iframe
* Icons for buttons
* Rewriting the build process
* Simplier state management
* Buttons are hidden using CSS
2021-03-01 18:38:39 +01:00

265 lines
8.7 KiB
JavaScript

'use strict'
function register ({ registerHook, peertubeHelpers }) {
const logger = {
log: (s) => console.log('[peertube-plugin-livechat] ' + s),
info: (s) => console.info('[peertube-plugin-livechat] ' + s),
error: (s) => console.error('[peertube-plugin-livechat] ' + s),
warn: (s) => console.warn('[peertube-plugin-livechat] ' + s)
}
const videoCache = {}
let lastUUID = null
let settings = {}
function parseUUIDs (s) {
if (!s) {
return []
}
let a = s.split('\n')
a = a.map(line => {
return line.replace(/#.*$/, '')
.replace(/^\s+/, '')
.replace(/\s+$/, '')
})
return a.filter(line => line !== '')
}
function getBaseRoute () {
// FIXME: should be provided by PeertubeHelpers (does not exists for now)
// We are guessing the route with the correct plugin version with this trick:
const staticBase = peertubeHelpers.getBaseStaticRoute()
// we can't use '/plugins/livechat/router', because the loaded html page needs correct relative paths.
return staticBase.replace(/\/static.*$/, '/router')
}
function getIframeUri (uuid) {
if (!settings) {
logger.error('Settings are not initialized, too soon to compute the iframeUri')
return null
}
let iframeUri = ''
if (!settings['chat-use-builtin']) {
iframeUri = settings['chat-uri'] || ''
iframeUri = iframeUri.replace(/{{VIDEO_UUID}}/g, uuid)
if (!/^https?:\/\//.test(iframeUri)) {
logger.error('The webchaturi must begin with https://')
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
}
function displayButton (buttonContainer, name, label, callback, icon) {
const button = document.createElement('button')
button.classList.add(
'peertube-plugin-livechat-button',
'peertube-plugin-livechat-button-' + name
)
button.onclick = callback
if (icon) {
const iconUrl = peertubeHelpers.getBaseStaticRoute() + '/images/' + icon
const iconEl = document.createElement('span')
iconEl.classList.add('peertube-plugin-livechat-button-icon')
iconEl.setAttribute('style',
'background-image: url(\'' + iconUrl + '\');'
)
button.prepend(iconEl)
button.setAttribute('title', label)
} else {
button.textContent = label
}
buttonContainer.append(button)
}
function insertChatDom (container, peertubeHelpers, uuid, showOpenBlank) {
logger.log('Adding livechat in the DOM...')
const p = new Promise((resolve, reject) => {
Promise.all([
peertubeHelpers.translate('Open chat'),
peertubeHelpers.translate('Open chat in a new window'),
peertubeHelpers.translate('Close chat')
]).then(labels => {
const labelOpen = labels[0]
const labelOpenBlank = labels[1]
const labelClose = labels[2]
const iframeUri = getIframeUri(uuid)
if (!iframeUri) {
return reject(new Error('No uri, cant display the buttons.'))
}
const buttonContainer = document.createElement('div')
buttonContainer.classList.add('peertube-plugin-livechat-buttons')
container.append(buttonContainer)
displayButton(buttonContainer, 'open', labelOpen, () => openChat(), 'talking.png')
if (showOpenBlank) {
displayButton(buttonContainer, 'openblank', labelOpenBlank, () => {
closeChat()
window.open(iframeUri)
}, 'talking-new-window.png')
}
displayButton(buttonContainer, 'close', labelClose, () => closeChat(), 'bye.png')
resolve()
})
})
return p
}
function openChat () {
const p = new Promise((resolve, reject) => {
const uuid = lastUUID
if (!uuid) {
logger.log('No current uuid.')
return reject(new Error('No current uuid.'))
}
logger.info('Trying to load the chat for video ' + uuid + '.')
const iframeUri = getIframeUri(uuid)
if (!iframeUri) {
logger.error('Incorrect iframe uri')
return reject(new Error('Incorrect iframe uri'))
}
const additionalStyles = settings['chat-style'] || ''
logger.info('Opening the chat...')
const container = document.getElementById('peertube-plugin-livechat-container')
if (!container) {
logger.error('Cant found the livechat container.')
return reject(new Error('Cant found the livechat container'))
}
if (container.querySelector('iframe')) {
logger.error('Seems that there is already an iframe in the container.')
return reject(new Error('Seems that there is already an iframe in the container.'))
}
// Creating the iframe...
const iframe = document.createElement('iframe')
iframe.setAttribute('src', iframeUri)
iframe.setAttribute('sandbox', 'allow-same-origin allow-scripts allow-popups allow-forms')
iframe.setAttribute('frameborder', '0')
if (additionalStyles) {
iframe.setAttribute('style', additionalStyles)
}
container.append(iframe)
container.setAttribute('peertube-plugin-livechat-state', 'open')
resolve()
})
return p
}
function closeChat () {
const container = document.getElementById('peertube-plugin-livechat-container')
if (!container) {
logger.error('Cant close livechat, container not found.')
return
}
container.querySelectorAll('iframe')
.forEach(dom => dom.remove())
container.setAttribute('peertube-plugin-livechat-state', 'closed')
}
function initChat () {
const videoWrapper = document.querySelector('#video-wrapper')
if (!videoWrapper) {
logger.error('The required div is not present in the DOM.')
return
}
let container = videoWrapper.querySelector('#peertube-plugin-livechat-container')
if (container) {
logger.log('The chat seems already initialized...')
return
}
container = document.createElement('div')
container.setAttribute('id', 'peertube-plugin-livechat-container')
container.setAttribute('peertube-plugin-livechat-state', 'initializing')
videoWrapper.append(container)
peertubeHelpers.getSettings().then(s => {
settings = s
const liveOn = !!settings['chat-all-lives']
const nonLiveOn = !!settings['chat-all-non-lives']
const uuids = parseUUIDs(settings['chat-videos-list'])
if (!uuids.length && !liveOn && !nonLiveOn) {
logger.log('Feature not activated.')
return
}
logger.log('Checking if this video should have a chat...')
const uuid = lastUUID
const video = videoCache[uuid]
if (!video) {
logger.error('Can\'t find the video ' + uuid + ' in the videoCache')
return
}
if (settings['chat-only-locals' && !video.isLocal]) {
logger.log('This video is not local, and we dont want chats on non local videos.')
return
}
if (uuids.indexOf(uuid) >= 0) {
logger.log('This video is in the list for chats.')
} else if (video.isLive && liveOn) {
logger.log('This video is live and we want all lives.')
} else if (!video.isLive && nonLiveOn) {
logger.log('This video is not live and we want all non-lives.')
} else {
logger.log('This video will not have a chat.')
return
}
insertChatDom(container, peertubeHelpers, uuid, !!settings['chat-open-blank']).then(() => {
if (settings['chat-auto-display']) {
openChat()
} else {
container.setAttribute('peertube-plugin-livechat-state', 'closed')
}
})
})
}
registerHook({
target: 'filter:api.video-watch.video.get.result',
handler: (video) => {
// For now, hooks for action:video-watch... did not receive the video object
// So we store video objects in videoCache
videoCache[video.uuid] = video
lastUUID = video.uuid
// FIXME: this should be made in action:video-watch.video.loaded.
// But with Peertube 3.0.1, this hook is not called for lives
// in WAITING_FOR_LIVE and LIVE_ENDED states.
initChat()
return video
}
})
// FIXME: this should be the correct hook for initChat...
// registerHook({
// target: 'action:video-watch.video.loaded',
// handler: () => {
// initChat()
// }
// })
}
export {
register
}