2 import videojs from 'video.js'
3 import { peertubeTranslate } from '../../../../shared/core-utils/i18n'
4 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
16 VideoStreamingPlaylistType
17 } from '../../../../shared/models'
18 import { P2PMediaLoaderOptions, PeertubePlayerManagerOptions, PlayerMode } from '../../assets/player/peertube-player-manager'
19 import { VideoJSCaption } from '../../assets/player/peertube-videojs-typings'
20 import { TranslationsManager } from '../../assets/player/translations-manager'
21 import { peertubeLocalStorage } from '../../root-helpers/peertube-web-storage'
22 import { Hooks, loadPlugin, runHook } from '../../root-helpers/plugins'
23 import { Tokens } from '../../root-helpers/users'
24 import { objectToUrlEncoded } from '../../root-helpers/utils'
25 import { RegisterClientHelpers } from '../../types/register-client-option.model'
26 import { PeerTubeEmbedApi } from './embed-api'
28 type Translations = { [ id: string ]: string }
30 export class PeerTubeEmbed {
31 playerElement: HTMLVideoElement
32 player: videojs.Player
33 api: PeerTubeEmbedApi = null
41 startTime: number | string = 0
42 stopTime: number | string
47 bigPlayBackgroundColor: string
48 foregroundColor: string
54 headers = new Headers()
55 LOCAL_STORAGE_OAUTH_CLIENT_KEYS = {
56 CLIENT_ID: 'client_id',
57 CLIENT_SECRET: 'client_secret'
60 config: HTMLServerConfig
62 private translationsPromise: Promise<{ [id: string]: string }>
63 private PeertubePlayerManagerModulePromise: Promise<any>
65 private playlist: VideoPlaylist
66 private playlistElements: VideoPlaylistElement[]
67 private currentPlaylistElement: VideoPlaylistElement
69 private wrapperElement: HTMLElement
71 private peertubeHooks: Hooks = {}
72 private loadedScripts = new Set<string>()
74 static async main () {
75 const videoContainerId = 'video-wrapper'
76 const embed = new PeerTubeEmbed(videoContainerId)
80 constructor (private videoWrapperId: string) {
81 this.wrapperElement = document.getElementById(this.videoWrapperId)
84 this.config = JSON.parse(window['PeerTubeServerConfig'])
86 console.error('Cannot parse HTML config.', err)
90 getVideoUrl (id: string) {
91 return window.location.origin + '/api/v1/videos/' + id
94 refreshFetch (url: string, options?: RequestInit) {
95 return fetch(url, options)
96 .then((res: Response) => {
97 if (res.status !== HttpStatusCode.UNAUTHORIZED_401) return res
99 const refreshingTokenPromise = new Promise<void>((resolve, reject) => {
100 const clientId: string = peertubeLocalStorage.getItem(this.LOCAL_STORAGE_OAUTH_CLIENT_KEYS.CLIENT_ID)
101 const clientSecret: string = peertubeLocalStorage.getItem(this.LOCAL_STORAGE_OAUTH_CLIENT_KEYS.CLIENT_SECRET)
103 const headers = new Headers()
104 headers.set('Content-Type', 'application/x-www-form-urlencoded')
107 refresh_token: this.userTokens.refreshToken,
109 client_secret: clientSecret,
110 response_type: 'code',
111 grant_type: 'refresh_token'
114 fetch('/api/v1/users/token', {
117 body: objectToUrlEncoded(data)
119 if (res.status === HttpStatusCode.UNAUTHORIZED_401) return undefined
122 }).then((obj: UserRefreshToken & { code?: OAuth2ErrorCode }) => {
123 if (!obj || obj.code === OAuth2ErrorCode.INVALID_GRANT) {
125 this.removeTokensFromHeaders()
130 this.userTokens.accessToken = obj.access_token
131 this.userTokens.refreshToken = obj.refresh_token
132 this.userTokens.save()
134 this.setHeadersFromTokens()
137 }).catch((refreshTokenError: any) => {
138 reject(refreshTokenError)
142 return refreshingTokenPromise
146 this.removeTokensFromHeaders()
147 }).then(() => fetch(url, {
149 headers: this.headers
154 getPlaylistUrl (id: string) {
155 return window.location.origin + '/api/v1/video-playlists/' + id
158 loadVideoInfo (videoId: string): Promise<Response> {
159 return this.refreshFetch(this.getVideoUrl(videoId), { headers: this.headers })
162 loadVideoCaptions (videoId: string): Promise<Response> {
163 return this.refreshFetch(this.getVideoUrl(videoId) + '/captions', { headers: this.headers })
166 loadPlaylistInfo (playlistId: string): Promise<Response> {
167 return this.refreshFetch(this.getPlaylistUrl(playlistId), { headers: this.headers })
170 loadPlaylistElements (playlistId: string, start = 0): Promise<Response> {
171 const url = new URL(this.getPlaylistUrl(playlistId) + '/videos')
172 url.search = new URLSearchParams({ start: '' + start, count: '100' }).toString()
174 return this.refreshFetch(url.toString(), { headers: this.headers })
177 removeElement (element: HTMLElement) {
178 element.parentElement.removeChild(element)
181 displayError (text: string, translations?: Translations) {
182 // Remove video element
183 if (this.playerElement) {
184 this.removeElement(this.playerElement)
185 this.playerElement = undefined
188 const translatedText = peertubeTranslate(text, translations)
189 const translatedSorry = peertubeTranslate('Sorry', translations)
191 document.title = translatedSorry + ' - ' + translatedText
193 const errorBlock = document.getElementById('error-block')
194 errorBlock.style.display = 'flex'
196 const errorTitle = document.getElementById('error-title')
197 errorTitle.innerHTML = peertubeTranslate('Sorry', translations)
199 const errorText = document.getElementById('error-content')
200 errorText.innerHTML = translatedText
202 this.wrapperElement.style.display = 'none'
205 videoNotFound (translations?: Translations) {
206 const text = 'This video does not exist.'
207 this.displayError(text, translations)
210 videoFetchError (translations?: Translations) {
211 const text = 'We cannot fetch the video. Please try again later.'
212 this.displayError(text, translations)
215 playlistNotFound (translations?: Translations) {
216 const text = 'This playlist does not exist.'
217 this.displayError(text, translations)
220 playlistFetchError (translations?: Translations) {
221 const text = 'We cannot fetch the playlist. Please try again later.'
222 this.displayError(text, translations)
225 getParamToggle (params: URLSearchParams, name: string, defaultValue?: boolean) {
226 return params.has(name) ? (params.get(name) === '1' || params.get(name) === 'true') : defaultValue
229 getParamString (params: URLSearchParams, name: string, defaultValue?: string) {
230 return params.has(name) ? params.get(name) : defaultValue
233 async playNextVideo () {
234 const next = this.getNextPlaylistElement()
236 console.log('Next element not found in playlist.')
240 this.currentPlaylistElement = next
242 return this.loadVideoAndBuildPlayer(this.currentPlaylistElement.video.uuid)
245 async playPreviousVideo () {
246 const previous = this.getPreviousPlaylistElement()
248 console.log('Previous element not found in playlist.')
252 this.currentPlaylistElement = previous
254 await this.loadVideoAndBuildPlayer(this.currentPlaylistElement.video.uuid)
257 getCurrentPosition () {
258 if (!this.currentPlaylistElement) return -1
260 return this.currentPlaylistElement.position
265 this.userTokens = Tokens.load()
266 await this.initCore()
272 private initializeApi () {
273 if (!this.enableApi) return
275 this.api = new PeerTubeEmbedApi(this)
276 this.api.initialize()
279 private loadParams (video: VideoDetails) {
281 const params = new URL(window.location.toString()).searchParams
283 this.autoplay = this.getParamToggle(params, 'autoplay', false)
284 this.controls = this.getParamToggle(params, 'controls', true)
285 this.muted = this.getParamToggle(params, 'muted', undefined)
286 this.loop = this.getParamToggle(params, 'loop', false)
287 this.title = this.getParamToggle(params, 'title', true)
288 this.enableApi = this.getParamToggle(params, 'api', this.enableApi)
289 this.warningTitle = this.getParamToggle(params, 'warningTitle', true)
290 this.peertubeLink = this.getParamToggle(params, 'peertubeLink', true)
292 this.scope = this.getParamString(params, 'scope', this.scope)
293 this.subtitle = this.getParamString(params, 'subtitle')
294 this.startTime = this.getParamString(params, 'start')
295 this.stopTime = this.getParamString(params, 'stop')
297 this.bigPlayBackgroundColor = this.getParamString(params, 'bigPlayBackgroundColor')
298 this.foregroundColor = this.getParamString(params, 'foregroundColor')
300 const modeParam = this.getParamString(params, 'mode')
303 if (modeParam === 'p2p-media-loader') this.mode = 'p2p-media-loader'
304 else this.mode = 'webtorrent'
306 if (Array.isArray(video.streamingPlaylists) && video.streamingPlaylists.length !== 0) this.mode = 'p2p-media-loader'
307 else this.mode = 'webtorrent'
310 console.error('Cannot get params from URL.', err)
314 private async loadAllPlaylistVideos (playlistId: string, baseResult: ResultList<VideoPlaylistElement>) {
315 let elements = baseResult.data
316 let total = baseResult.total
319 while (total > elements.length && i < 10) {
320 const result = await this.loadPlaylistElements(playlistId, elements.length)
322 const json = await result.json() as ResultList<VideoPlaylistElement>
325 elements = elements.concat(json.data)
330 console.error('Cannot fetch all playlists elements, there are too many!')
336 private async loadPlaylist (playlistId: string) {
337 const playlistPromise = this.loadPlaylistInfo(playlistId)
338 const playlistElementsPromise = this.loadPlaylistElements(playlistId)
340 let playlistResponse: Response
341 let isResponseOk: boolean
344 playlistResponse = await playlistPromise
345 isResponseOk = playlistResponse.status === HttpStatusCode.OK_200
352 const serverTranslations = await this.translationsPromise
354 if (playlistResponse?.status === HttpStatusCode.NOT_FOUND_404) {
355 this.playlistNotFound(serverTranslations)
359 this.playlistFetchError(serverTranslations)
363 return { playlistResponse, videosResponse: await playlistElementsPromise }
366 private async loadVideo (videoId: string) {
367 const videoPromise = this.loadVideoInfo(videoId)
369 let videoResponse: Response
370 let isResponseOk: boolean
373 videoResponse = await videoPromise
374 isResponseOk = videoResponse.status === HttpStatusCode.OK_200
382 const serverTranslations = await this.translationsPromise
384 if (videoResponse?.status === HttpStatusCode.NOT_FOUND_404) {
385 this.videoNotFound(serverTranslations)
389 this.videoFetchError(serverTranslations)
393 const captionsPromise = this.loadVideoCaptions(videoId)
395 return { captionsPromise, videoResponse }
398 private async buildPlaylistManager () {
399 const translations = await this.translationsPromise
402 timeout: 10000, // 10s
403 headText: peertubeTranslate('Up Next', translations),
404 cancelText: peertubeTranslate('Cancel', translations),
405 suspendedText: peertubeTranslate('Autoplay is suspended', translations),
406 getTitle: () => this.nextVideoTitle(),
407 next: () => this.playNextVideo(),
408 condition: () => !!this.getNextPlaylistElement(),
409 suspended: () => false
413 private async loadVideoAndBuildPlayer (uuid: string) {
414 const res = await this.loadVideo(uuid)
415 if (res === undefined) return
417 return this.buildVideoPlayer(res.videoResponse, res.captionsPromise)
420 private nextVideoTitle () {
421 const next = this.getNextPlaylistElement()
424 return next.video.name
427 private getNextPlaylistElement (position?: number): VideoPlaylistElement {
428 if (!position) position = this.currentPlaylistElement.position + 1
430 if (position > this.playlist.videosLength) {
434 const next = this.playlistElements.find(e => e.position === position)
436 if (!next || !next.video) {
437 return this.getNextPlaylistElement(position + 1)
443 private getPreviousPlaylistElement (position?: number): VideoPlaylistElement {
444 if (!position) position = this.currentPlaylistElement.position - 1
450 const prev = this.playlistElements.find(e => e.position === position)
452 if (!prev || !prev.video) {
453 return this.getNextPlaylistElement(position - 1)
459 private async buildVideoPlayer (videoResponse: Response, captionsPromise: Promise<Response>) {
460 let alreadyHadPlayer = false
463 this.player.dispose()
464 alreadyHadPlayer = true
467 this.playerElement = document.createElement('video')
468 this.playerElement.className = 'video-js vjs-peertube-skin'
469 this.playerElement.setAttribute('playsinline', 'true')
470 this.wrapperElement.appendChild(this.playerElement)
472 // Issue when we parsed config from HTML, fallback to API
474 this.config = await this.refreshFetch('/api/v1/config')
475 .then(res => res.json())
478 const videoInfoPromise = videoResponse.json()
479 .then((videoInfo: VideoDetails) => {
480 if (!alreadyHadPlayer) this.loadPlaceholder(videoInfo)
485 const [ videoInfoTmp, serverTranslations, captionsResponse, PeertubePlayerManagerModule ] = await Promise.all([
487 this.translationsPromise,
489 this.PeertubePlayerManagerModulePromise
492 await this.ensurePluginsAreLoaded(serverTranslations)
494 const videoInfo: VideoDetails = videoInfoTmp
496 const PeertubePlayerManager = PeertubePlayerManagerModule.PeertubePlayerManager
497 const videoCaptions = await this.buildCaptions(serverTranslations, captionsResponse)
499 this.loadParams(videoInfo)
501 const playlistPlugin = this.currentPlaylistElement
503 elements: this.playlistElements,
504 playlist: this.playlist,
506 getCurrentPosition: () => this.currentPlaylistElement.position,
508 onItemClicked: (videoPlaylistElement: VideoPlaylistElement) => {
509 this.currentPlaylistElement = videoPlaylistElement
511 this.loadVideoAndBuildPlayer(this.currentPlaylistElement.video.uuid)
512 .catch(err => console.error(err))
517 const options: PeertubePlayerManagerOptions = {
519 // Autoplay in playlist mode
520 autoplay: alreadyHadPlayer ? true : this.autoplay,
521 controls: this.controls,
525 captions: videoCaptions.length !== 0,
526 subtitle: this.subtitle,
528 startTime: this.playlist ? this.currentPlaylistElement.startTimestamp : this.startTime,
529 stopTime: this.playlist ? this.currentPlaylistElement.stopTimestamp : this.stopTime,
531 nextVideo: this.playlist ? () => this.playNextVideo() : undefined,
532 hasNextVideo: this.playlist ? () => !!this.getNextPlaylistElement() : undefined,
534 previousVideo: this.playlist ? () => this.playPreviousVideo() : undefined,
535 hasPreviousVideo: this.playlist ? () => !!this.getPreviousPlaylistElement() : undefined,
537 playlist: playlistPlugin,
540 inactivityTimeout: 2500,
541 videoViewUrl: this.getVideoUrl(videoInfo.uuid) + '/views',
542 videoUUID: videoInfo.uuid,
544 isLive: videoInfo.isLive,
546 playerElement: this.playerElement,
547 onPlayerElementChange: (element: HTMLVideoElement) => this.playerElement = element,
549 videoDuration: videoInfo.duration,
551 peertubeLink: this.peertubeLink,
552 poster: window.location.origin + videoInfo.previewPath,
553 theaterButton: false,
555 serverUrl: window.location.origin,
556 language: navigator.language,
557 embedUrl: window.location.origin + videoInfo.embedPath,
558 embedTitle: videoInfo.name
562 videoFiles: videoInfo.files
566 if (this.mode === 'p2p-media-loader') {
567 const hlsPlaylist = videoInfo.streamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
569 Object.assign(options, {
571 playlistUrl: hlsPlaylist.playlistUrl,
572 segmentsSha256Url: hlsPlaylist.segmentsSha256Url,
573 redundancyBaseUrls: hlsPlaylist.redundancies.map(r => r.baseUrl),
574 trackerAnnounce: videoInfo.trackerUrls,
575 videoFiles: hlsPlaylist.files
576 } as P2PMediaLoaderOptions
580 this.player = await PeertubePlayerManager.initialize(this.mode, options, (player: videojs.Player) => this.player = player)
581 this.player.on('customError', (event: any, data: any) => this.handleError(data.err, serverTranslations))
583 window[ 'videojsPlayer' ] = this.player
587 await this.buildDock(videoInfo)
591 this.removePlaceholder()
593 if (this.isPlaylistEmbed()) {
594 await this.buildPlaylistManager()
596 this.player.playlist().updateSelected()
598 this.player.on('stopped', () => {
603 this.runHook('action:embed.player.loaded', undefined, { player: this.player, videojs, video: videoInfo })
606 private async initCore () {
607 if (this.userTokens) this.setHeadersFromTokens()
609 this.translationsPromise = TranslationsManager.getServerTranslations(window.location.origin, navigator.language)
610 this.PeertubePlayerManagerModulePromise = import('../../assets/player/peertube-player-manager')
614 if (this.isPlaylistEmbed()) {
615 const playlistId = this.getResourceId()
616 const res = await this.loadPlaylist(playlistId)
617 if (!res) return undefined
619 this.playlist = await res.playlistResponse.json()
621 const playlistElementResult = await res.videosResponse.json()
622 this.playlistElements = await this.loadAllPlaylistVideos(playlistId, playlistElementResult)
624 const params = new URL(window.location.toString()).searchParams
625 const playlistPositionParam = this.getParamString(params, 'playlistPosition')
629 if (playlistPositionParam) {
630 position = parseInt(playlistPositionParam + '', 10)
633 this.currentPlaylistElement = this.playlistElements.find(e => e.position === position)
634 if (!this.currentPlaylistElement || !this.currentPlaylistElement.video) {
635 console.error('Current playlist element is not valid.', this.currentPlaylistElement)
636 this.currentPlaylistElement = this.getNextPlaylistElement()
639 if (!this.currentPlaylistElement) {
640 console.error('This playlist does not have any valid element.')
641 const serverTranslations = await this.translationsPromise
642 this.playlistFetchError(serverTranslations)
646 videoId = this.currentPlaylistElement.video.uuid
648 videoId = this.getResourceId()
651 return this.loadVideoAndBuildPlayer(videoId)
654 private handleError (err: Error, translations?: { [ id: string ]: string }) {
655 if (err.message.indexOf('from xs param') !== -1) {
656 this.player.dispose()
657 this.playerElement = null
658 this.displayError('This video is not available because the remote instance is not responding.', translations)
663 private async buildDock (videoInfo: VideoDetails) {
664 if (!this.controls) return
666 // On webtorrent fallback, player may have been disposed
667 if (!this.player.player_) return
669 const title = this.title ? videoInfo.name : undefined
671 const description = this.config.tracker.enabled && this.warningTitle
672 ? '<span class="text">' + peertubeTranslate('Watching this video may reveal your IP address to others.') + '</span>'
675 if (title || description) {
683 private buildCSS () {
684 const body = document.getElementById('custom-css')
686 if (this.bigPlayBackgroundColor) {
687 body.style.setProperty('--embedBigPlayBackgroundColor', this.bigPlayBackgroundColor)
690 if (this.foregroundColor) {
691 body.style.setProperty('--embedForegroundColor', this.foregroundColor)
695 private async buildCaptions (serverTranslations: any, captionsResponse: Response): Promise<VideoJSCaption[]> {
696 if (captionsResponse.ok) {
697 const { data } = (await captionsResponse.json()) as ResultList<VideoCaption>
699 return data.map(c => ({
700 label: peertubeTranslate(c.language.label, serverTranslations),
701 language: c.language.id,
702 src: window.location.origin + c.captionPath
709 private loadPlaceholder (video: VideoDetails) {
710 const placeholder = this.getPlaceholderElement()
712 const url = window.location.origin + video.previewPath
713 placeholder.style.backgroundImage = `url("${url}")`
714 placeholder.style.display = 'block'
717 private removePlaceholder () {
718 const placeholder = this.getPlaceholderElement()
719 placeholder.style.display = 'none'
722 private getPlaceholderElement () {
723 return document.getElementById('placeholder-preview')
726 private setHeadersFromTokens () {
727 this.headers.set('Authorization', `${this.userTokens.tokenType} ${this.userTokens.accessToken}`)
730 private removeTokensFromHeaders () {
731 this.headers.delete('Authorization')
734 private getResourceId () {
735 const urlParts = window.location.pathname.split('/')
736 return urlParts[ urlParts.length - 1 ]
739 private isPlaylistEmbed () {
740 return window.location.pathname.split('/')[1] === 'video-playlists'
743 private async ensurePluginsAreLoaded (translations?: { [ id: string ]: string }) {
744 if (this.config.plugin.registered.length === 0) return
746 for (const plugin of this.config.plugin.registered) {
747 for (const key of Object.keys(plugin.clientScripts)) {
748 const clientScript = plugin.clientScripts[key]
750 if (clientScript.scopes.includes('embed') === false) continue
752 const script = `/plugins/${plugin.name}/${plugin.version}/client-scripts/${clientScript.script}`
754 if (this.loadedScripts.has(script)) continue
760 scopes: clientScript.scopes
762 pluginType: PluginType.PLUGIN,
767 hooks: this.peertubeHooks,
769 onSettingsScripts: () => undefined,
770 peertubeHelpersFactory: _ => this.buildPeerTubeHelpers(translations)
776 private buildPeerTubeHelpers (translations?: { [ id: string ]: string }): RegisterClientHelpers {
777 function unimplemented (): any {
778 throw new Error('This helper is not implemented in embed.')
782 getBaseStaticRoute: unimplemented,
784 getSettings: unimplemented,
786 isLoggedIn: unimplemented,
787 getAuthHeader: unimplemented,
791 error: unimplemented,
792 success: unimplemented
795 showModal: unimplemented,
797 getServerConfig: unimplemented,
800 textMarkdownToHTML: unimplemented,
801 enhancedMarkdownToHTML: unimplemented
804 translate: (value: string) => {
805 return Promise.resolve(peertubeTranslate(value, translations))
810 private runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> {
811 return runHook(this.peertubeHooks, hookName, result, params)
816 .catch(err => console.error('Cannot init embed.', err))