peertube-plugin-livechat/client/videowatch/share.ts

312 lines
11 KiB
TypeScript

import type { RegisterClientOptions } from '@peertube/peertube-types/client'
import type { Video } from '@peertube/peertube-types'
import { logger } from './logger'
import { getIframeUri, UriOptions } from './uri'
import { isAutoColorsAvailable } from 'shared/lib/autocolors'
interface ShareForm {
shareString: HTMLInputElement
openButton: HTMLButtonElement
copyButton: HTMLButtonElement
readonly: HTMLInputElement
withscroll: HTMLInputElement
transparent: HTMLInputElement
readonlyOptions: HTMLElement
autoColors?: HTMLInputElement
generateIframe: HTMLInputElement
}
async function shareChatUrl (registerOptions: RegisterClientOptions, settings: any, video: Video): Promise<void> {
const peertubeHelpers = registerOptions.peertubeHelpers
const [
labelShare,
labelReadonly,
labelWithscroll,
labelTransparent,
tipsOBS,
labelCopy,
labelCopied,
labelError,
labelOpen,
labelAutocolors,
labelGenerateIframe,
labelChatFor
] = await Promise.all([
peertubeHelpers.translate('Share chat link'),
peertubeHelpers.translate('Read-only'),
peertubeHelpers.translate('Show the scrollbar'),
peertubeHelpers.translate('Transparent background (for stream integration, with OBS for example)'),
// eslint-disable-next-line max-len
peertubeHelpers.translate('Tips for streamers: To add the chat to your OBS, generate a read-only link and use it as a browser source.'),
peertubeHelpers.translate('Copy'),
peertubeHelpers.translate('Link copied'),
peertubeHelpers.translate('Error'),
peertubeHelpers.translate('Open'),
peertubeHelpers.translate('Use current theme colors'),
peertubeHelpers.translate('Generate an iframe to embed the chat in a website'),
peertubeHelpers.translate('Chat for live stream:')
])
const defaultUri = getIframeUri(registerOptions, settings, video)
if (!defaultUri) {
return
}
let form: ShareForm | undefined
function renderContent (container: HTMLElement): void {
if (!form) {
container.childNodes.forEach(child => container.removeChild(child))
container.classList.add('peertube-plugin-livechat-shareurl-modal')
const divShareString = document.createElement('div')
divShareString.classList.add('livechat-shareurl-copy')
const shareString = document.createElement('input')
shareString.setAttribute('type', 'text')
shareString.setAttribute('readonly', '')
shareString.setAttribute('autocomplete', 'off')
shareString.setAttribute('placeholder', '')
shareString.classList.add('form-control', 'readonly')
divShareString.append(shareString)
const copyButton = document.createElement('button')
copyButton.classList.add('btn', 'btn-outline-secondary', 'text-uppercase')
copyButton.textContent = labelCopy
divShareString.append(copyButton)
const openButton = document.createElement('button')
openButton.classList.add('btn', 'btn-outline-secondary', 'text-uppercase')
openButton.textContent = labelOpen
divShareString.append(openButton)
container.append(divShareString)
const divTips = document.createElement('div')
divTips.textContent = tipsOBS
container.append(divTips)
const divCustom = document.createElement('div')
divCustom.classList.add('livechat-shareurl-custom')
container.append(divCustom)
const readonly = document.createElement('input')
readonly.setAttribute('type', 'checkbox')
const readonlyLabelEl = document.createElement('label')
readonlyLabelEl.textContent = labelReadonly
readonlyLabelEl.prepend(readonly)
divCustom.append(readonlyLabelEl)
const readonlyOptions = document.createElement('div')
readonlyOptions.classList.add('livechat-shareurl-custom-readonly-options')
divCustom.append(readonlyOptions)
const withscroll = document.createElement('input')
withscroll.setAttribute('type', 'checkbox')
const withscrollLabelEl = document.createElement('label')
withscrollLabelEl.textContent = labelWithscroll
withscrollLabelEl.prepend(withscroll)
readonlyOptions.append(withscrollLabelEl)
const transparent = document.createElement('input')
transparent.setAttribute('type', 'checkbox')
const transparentLabelEl = document.createElement('label')
transparentLabelEl.textContent = labelTransparent
transparentLabelEl.prepend(transparent)
readonlyOptions.append(transparentLabelEl)
let autoColors
if (isAutoColorsAvailable(settings['converse-theme'])) {
const label = document.createElement('label')
label.innerText = labelAutocolors
autoColors = document.createElement('input')
autoColors.setAttribute('type', 'checkbox')
label.prepend(autoColors)
divCustom.append(label)
}
const generateIframe = document.createElement('input')
generateIframe.setAttribute('type', 'checkbox')
const generateIframeLabelEl = document.createElement('label')
generateIframeLabelEl.textContent = labelGenerateIframe
generateIframeLabelEl.prepend(generateIframe)
divCustom.append(generateIframeLabelEl)
readonly.onclick = () => {
renderContent(container)
}
withscroll.onclick = () => {
renderContent(container)
}
transparent.onclick = () => {
renderContent(container)
}
if (autoColors) {
autoColors.onclick = () => {
renderContent(container)
}
}
generateIframe.onclick = () => {
renderContent(container)
}
shareString.onclick = () => {
shareString.select()
shareString.setSelectionRange(0, 99999) /* For mobile devices */
}
copyButton.onclick = () => {
shareString.select()
shareString.setSelectionRange(0, 99999) /* For mobile devices */
navigator.clipboard.writeText(shareString.value).then(() => {
peertubeHelpers.notifier.success(labelCopied)
}, () => {
peertubeHelpers.notifier.error(labelError)
})
}
openButton.onclick = () => {
// Don't open the url if it is an iframe!
if (shareString.value.startsWith('http')) {
window.open(shareString.value)
}
}
form = {
shareString,
copyButton,
openButton,
readonly,
withscroll,
transparent,
readonlyOptions,
autoColors,
generateIframe
}
restore(form)
}
// Saving the form state, to restore each time the modal is opened.
save(form)
const uriOptions: UriOptions = {
ignoreAutoColors: form.autoColors ? !form.autoColors.checked : true,
permanent: true
}
if (form.readonly.checked) {
if (form.withscroll.checked) {
uriOptions.readonly = true
} else {
uriOptions.readonly = 'noscroll'
}
if (form.transparent.checked) {
uriOptions.transparent = true
}
form.withscroll.disabled = false
form.transparent.disabled = false
form.readonlyOptions.classList.remove('livechat-shareurl-custom-readonly-disabled')
} else {
form.withscroll.disabled = true
form.transparent.disabled = true
form.readonlyOptions.classList.add('livechat-shareurl-custom-readonly-disabled')
}
let shareStringValue = getIframeUri(registerOptions, settings, video, uriOptions)
if (form.generateIframe.checked) {
form.openButton.disabled = true
if (shareStringValue) {
// To properly escape all attributes, we are constructing an HTMLIframeElement
const iframe = document.createElement('iframe')
iframe.setAttribute('src', shareStringValue)
iframe.setAttribute('title', labelChatFor + ' ' + video.name)
iframe.setAttribute('sandbox', 'allow-same-origin allow-scripts allow-popups allow-forms')
iframe.setAttribute('width', '560')
iframe.setAttribute('height', '315')
iframe.setAttribute('frameborder', '0')
shareStringValue = iframe.outerHTML
}
} else {
form.openButton.disabled = false
}
form.shareString.setAttribute('value', shareStringValue ?? '')
}
function save (form: ShareForm): void {
if (!window.localStorage) {
return
}
const v = {
version: 1, // in case we add incompatible values in a near feature
readonly: !!form.readonly.checked,
withscroll: !!form.withscroll.checked,
transparent: !!form.transparent.checked,
autocolors: !!form.autoColors?.checked,
generateIframe: !!form.generateIframe.checked
}
window.localStorage.setItem('peertube-plugin-livechat-shareurl', JSON.stringify(v))
}
function restore (form: ShareForm): void {
if (!window.localStorage) {
return
}
const s = window.localStorage.getItem('peertube-plugin-livechat-shareurl')
if (!s) {
return
}
let v: any
try {
v = JSON.parse(s)
if (!v || (typeof v !== 'object') || v.version !== 1) {
return
}
form.readonly.checked = !!v.readonly
form.withscroll.checked = !!v.withscroll
form.transparent.checked = !!v.transparent
if (form.autoColors) {
form.autoColors.checked = !!v.autocolors
}
form.generateIframe.checked = !!v.generateIframe
} catch (err) {
logger.error(err as string)
}
}
logger.info('Opening the share modal...')
const observer = new MutationObserver(mutations => {
for (const { addedNodes } of mutations) {
addedNodes.forEach(node => {
if ((node as HTMLElement).localName === 'ngb-modal-window') {
logger.info('Detecting a new modal, checking if this is the good one...')
if (!(node as HTMLElement).querySelector) { return }
const title = (node as HTMLElement).querySelector('.modal-title')
if (!(title?.textContent === labelShare)) {
return
}
logger.info('Yes, it is the good modal!')
observer.disconnect()
const modalBodyElem: HTMLElement | null = (node as HTMLElement).querySelector('.modal-body')
if (!modalBodyElem) {
logger.error('Modal has no body... Dont know how to fill it.')
return
}
renderContent(modalBodyElem)
}
})
}
})
observer.observe(document.body, {
childList: true
})
peertubeHelpers.showModal({
title: labelShare,
content: `<p>${defaultUri ?? ''}</p>`, // incase the observer is broken...
close: true
})
// just in case, remove the observer after a timeout, if not already done...
setTimeout(() => {
observer.disconnect()
}, 1000)
}
export {
shareChatUrl
}