client/src/standalone/videos/embed.ts

   1 import './embed.scss'
   2 import '../../assets/player/shared/dock/peertube-dock-component'
   3 import '../../assets/player/shared/dock/peertube-dock-plugin'
   4 import videojs from 'video.js'
   5 import { peertubeTranslate } from '../../../../shared/core-utils/i18n'
   6 import { HTMLServerConfig, ResultList, VideoDetails, VideoPlaylist, VideoPlaylistElement } from '../../../../shared/models'
   7 import { PeertubePlayerManager } from '../../assets/player'
   8 import { TranslationsManager } from '../../assets/player/translations-manager'
   9 import { getParamString, logger, videoRequiresAuth } from '../../root-helpers'
  10 import { PeerTubeEmbedApi } from './embed-api'
  11 import { AuthHTTP, LiveManager, PeerTubePlugin, PlayerManagerOptions, PlaylistFetcher, PlaylistTracker, VideoFetcher } from './shared'
  12 import { PlayerHTML } from './shared/player-html'
  13
  14 export class PeerTubeEmbed {
  15   player: videojs.Player
  16   api: PeerTubeEmbedApi = null
  17
  18   config: HTMLServerConfig
  19
  20   private translationsPromise: Promise<{ [id: string]: string }>
  21   private PeertubePlayerManagerModulePromise: Promise<any>
  22
  23   private readonly http: AuthHTTP
  24   private readonly videoFetcher: VideoFetcher
  25   private readonly playlistFetcher: PlaylistFetcher
  26   private readonly peertubePlugin: PeerTubePlugin
  27   private readonly playerHTML: PlayerHTML
  28   private readonly playerManagerOptions: PlayerManagerOptions
  29   private readonly liveManager: LiveManager
  30
  31   private playlistTracker: PlaylistTracker
  32
  33   constructor (videoWrapperId: string) {
  34     logger.registerServerSending(window.location.origin)
  35
  36     this.http = new AuthHTTP()
  37
  38     this.videoFetcher = new VideoFetcher(this.http)
  39     this.playlistFetcher = new PlaylistFetcher(this.http)
  40     this.peertubePlugin = new PeerTubePlugin(this.http)
  41     this.playerHTML = new PlayerHTML(videoWrapperId)
  42     this.playerManagerOptions = new PlayerManagerOptions(this.playerHTML, this.videoFetcher, this.peertubePlugin)
  43     this.liveManager = new LiveManager(this.playerHTML)
  44
  45     try {
  46       this.config = JSON.parse(window['PeerTubeServerConfig'])
  47     } catch (err) {
  48       logger.error('Cannot parse HTML config.', err)
  49     }
  50   }
  51
  52   static async main () {
  53     const videoContainerId = 'video-wrapper'
  54     const embed = new PeerTubeEmbed(videoContainerId)
  55     await embed.init()
  56   }
  57
  58   getPlayerElement () {
  59     return this.playerHTML.getPlayerElement()
  60   }
  61
  62   getScope () {
  63     return this.playerManagerOptions.getScope()
  64   }
  65
  66   // ---------------------------------------------------------------------------
  67
  68   async init () {
  69     this.translationsPromise = TranslationsManager.getServerTranslations(window.location.origin, navigator.language)
  70     this.PeertubePlayerManagerModulePromise = import('../../assets/player/peertube-player-manager')
  71
  72     // Issue when we parsed config from HTML, fallback to API
  73     if (!this.config) {
  74       this.config = await this.http.fetch('/api/v1/config', { optionalAuth: false })
  75         .then(res => res.json())
  76     }
  77
  78     const videoId = this.isPlaylistEmbed()
  79       ? await this.initPlaylist()
  80       : this.getResourceId()
  81
  82     if (!videoId) return
  83
  84     return this.loadVideoAndBuildPlayer(videoId)
  85   }
  86
  87   private async initPlaylist () {
  88     const playlistId = this.getResourceId()
  89
  90     try {
  91       const res = await this.playlistFetcher.loadPlaylist(playlistId)
  92
  93       const [ playlist, playlistElementResult ] = await Promise.all([
  94         res.playlistResponse.json() as Promise<VideoPlaylist>,
  95         res.videosResponse.json() as Promise<ResultList<VideoPlaylistElement>>
  96       ])
  97
  98       const allPlaylistElements = await this.playlistFetcher.loadAllPlaylistVideos(playlistId, playlistElementResult)
  99
 100       this.playlistTracker = new PlaylistTracker(playlist, allPlaylistElements)
 101
 102       const params = new URL(window.location.toString()).searchParams
 103       const playlistPositionParam = getParamString(params, 'playlistPosition')
 104
 105       const position = playlistPositionParam
 106         ? parseInt(playlistPositionParam + '', 10)
 107         : 1
 108
 109       this.playlistTracker.setPosition(position)
 110     } catch (err) {
 111       this.playerHTML.displayError(err.message, await this.translationsPromise)
 112       return undefined
 113     }
 114
 115     return this.playlistTracker.getCurrentElement().video.uuid
 116   }
 117
 118   private initializeApi () {
 119     if (this.playerManagerOptions.hasAPIEnabled()) {
 120       this.api = new PeerTubeEmbedApi(this)
 121       this.api.initialize()
 122     }
 123   }
 124
 125   // ---------------------------------------------------------------------------
 126
 127   async playNextPlaylistVideo () {
 128     const next = this.playlistTracker.getNextPlaylistElement()
 129     if (!next) {
 130       logger.info('Next element not found in playlist.')
 131       return
 132     }
 133
 134     this.playlistTracker.setCurrentElement(next)
 135
 136     return this.loadVideoAndBuildPlayer(next.video.uuid)
 137   }
 138
 139   async playPreviousPlaylistVideo () {
 140     const previous = this.playlistTracker.getPreviousPlaylistElement()
 141     if (!previous) {
 142       logger.info('Previous element not found in playlist.')
 143       return
 144     }
 145
 146     this.playlistTracker.setCurrentElement(previous)
 147
 148     await this.loadVideoAndBuildPlayer(previous.video.uuid)
 149   }
 150
 151   getCurrentPlaylistPosition () {
 152     return this.playlistTracker.getCurrentPosition()
 153   }
 154
 155   // ---------------------------------------------------------------------------
 156
 157   private async loadVideoAndBuildPlayer (uuid: string) {
 158     try {
 159       const { videoResponse, captionsPromise } = await this.videoFetcher.loadVideo(uuid)
 160
 161       return this.buildVideoPlayer(videoResponse, captionsPromise)
 162     } catch (err) {
 163       this.playerHTML.displayError(err.message, await this.translationsPromise)
 164     }
 165   }
 166
 167   private async buildVideoPlayer (videoResponse: Response, captionsPromise: Promise<Response>) {
 168     const alreadyHadPlayer = this.resetPlayerElement()
 169
 170     const videoInfoPromise = videoResponse.json()
 171       .then(async (videoInfo: VideoDetails) => {
 172         this.playerManagerOptions.loadParams(this.config, videoInfo)
 173
 174         if (!alreadyHadPlayer && !this.playerManagerOptions.hasAutoplay()) {
 175           this.playerHTML.buildPlaceholder(videoInfo)
 176         }
 177         const live = videoInfo.isLive
 178           ? await this.videoFetcher.loadLive(videoInfo)
 179           : undefined
 180
 181         const videoFileToken = videoRequiresAuth(videoInfo)
 182           ? await this.videoFetcher.loadVideoToken(videoInfo)
 183           : undefined
 184
 185         return { live, video: videoInfo, videoFileToken }
 186       })
 187
 188     const [ { video, live, videoFileToken }, translations, captionsResponse, PeertubePlayerManagerModule ] = await Promise.all([
 189       videoInfoPromise,
 190       this.translationsPromise,
 191       captionsPromise,
 192       this.PeertubePlayerManagerModulePromise
 193     ])
 194
 195     await this.peertubePlugin.loadPlugins(this.config, translations)
 196
 197     const PlayerManager: typeof PeertubePlayerManager = PeertubePlayerManagerModule.PeertubePlayerManager
 198
 199     const options = await this.playerManagerOptions.getPlayerOptions({
 200       video,
 201       captionsResponse,
 202       alreadyHadPlayer,
 203       translations,
 204       serverConfig: this.config,
 205
 206       authorizationHeader: () => this.http.getHeaderTokenValue(),
 207       videoFileToken: () => videoFileToken,
 208
 209       onVideoUpdate: (uuid: string) => this.loadVideoAndBuildPlayer(uuid),
 210
 211       playlistTracker: this.playlistTracker,
 212       playNextPlaylistVideo: () => this.playNextPlaylistVideo(),
 213       playPreviousPlaylistVideo: () => this.playPreviousPlaylistVideo(),
 214
 215       live
 216     })
 217
 218     this.player = await PlayerManager.initialize(this.playerManagerOptions.getMode(), options, (player: videojs.Player) => {
 219       this.player = player
 220     })
 221
 222     this.player.on('customError', (event: any, data: any) => {
 223       const message = data?.err?.message || ''
 224       if (!message.includes('from xs param')) return
 225
 226       this.player.dispose()
 227       this.playerHTML.removePlayerElement()
 228       this.playerHTML.displayError('This video is not available because the remote instance is not responding.', translations)
 229     })
 230
 231     window['videojsPlayer'] = this.player
 232
 233     this.buildCSS()
 234     this.buildPlayerDock(video)
 235     this.initializeApi()
 236
 237     this.playerHTML.removePlaceholder()
 238
 239     if (this.isPlaylistEmbed()) {
 240       await this.buildPlayerPlaylistUpnext()
 241
 242       this.player.playlist().updateSelected()
 243
 244       this.player.on('stopped', () => {
 245         this.playNextPlaylistVideo()
 246       })
 247     }
 248
 249     this.peertubePlugin.getPluginsManager().runHook('action:embed.player.loaded', undefined, { player: this.player, videojs, video })
 250
 251     if (video.isLive) {
 252       this.liveManager.displayInfoAndListenForChanges({
 253         video,
 254         translations,
 255         onPublishedVideo: () => {
 256           this.liveManager.stopListeningForChanges(video)
 257           this.loadVideoAndBuildPlayer(video.uuid)
 258         }
 259       })
 260     }
 261   }
 262
 263   private resetPlayerElement () {
 264     let alreadyHadPlayer = false
 265
 266     if (this.player) {
 267       this.player.dispose()
 268       this.player = undefined
 269       alreadyHadPlayer = true
 270     }
 271
 272     const playerElement = document.createElement('video')
 273     playerElement.className = 'video-js vjs-peertube-skin'
 274     playerElement.setAttribute('playsinline', 'true')
 275
 276     this.playerHTML.setPlayerElement(playerElement)
 277     this.playerHTML.addPlayerElementToDOM()
 278
 279     return alreadyHadPlayer
 280   }
 281
 282   private async buildPlayerPlaylistUpnext () {
 283     const translations = await this.translationsPromise
 284
 285     this.player.upnext({
 286       timeout: 10000, // 10s
 287       headText: peertubeTranslate('Up Next', translations),
 288       cancelText: peertubeTranslate('Cancel', translations),
 289       suspendedText: peertubeTranslate('Autoplay is suspended', translations),
 290       getTitle: () => this.playlistTracker.nextVideoTitle(),
 291       next: () => this.playNextPlaylistVideo(),
 292       condition: () => !!this.playlistTracker.getNextPlaylistElement(),
 293       suspended: () => false
 294     })
 295   }
 296
 297   private buildPlayerDock (videoInfo: VideoDetails) {
 298     if (!this.playerManagerOptions.hasControls()) return
 299
 300     // On webtorrent fallback, player may have been disposed
 301     if (!this.player.player_) return
 302
 303     const title = this.playerManagerOptions.hasTitle()
 304       ? videoInfo.name
 305       : undefined
 306
 307     const description = this.playerManagerOptions.hasWarningTitle() && this.playerManagerOptions.hasP2PEnabled()
 308       ? '<span class="text">' + peertubeTranslate('Watching this video may reveal your IP address to others.') + '</span>'
 309       : undefined
 310
 311     if (!title && !description) return
 312
 313     const availableAvatars = videoInfo.channel.avatars.filter(a => a.width < 50)
 314     const avatar = availableAvatars.length !== 0
 315       ? availableAvatars[0]
 316       : undefined
 317
 318     this.player.peertubeDock({
 319       title,
 320       description,
 321       avatarUrl: title && avatar
 322         ? avatar.path
 323         : undefined
 324     })
 325   }
 326
 327   private buildCSS () {
 328     const body = document.getElementById('custom-css')
 329
 330     if (this.playerManagerOptions.hasBigPlayBackgroundColor()) {
 331       body.style.setProperty('--embedBigPlayBackgroundColor', this.playerManagerOptions.getBigPlayBackgroundColor())
 332     }
 333
 334     if (this.playerManagerOptions.hasForegroundColor()) {
 335       body.style.setProperty('--embedForegroundColor', this.playerManagerOptions.getForegroundColor())
 336     }
 337   }
 338
 339   // ---------------------------------------------------------------------------
 340
 341   private getResourceId () {
 342     const urlParts = window.location.pathname.split('/')
 343     return urlParts[urlParts.length - 1]
 344   }
 345
 346   private isPlaylistEmbed () {
 347     return window.location.pathname.split('/')[1] === 'video-playlists'
 348   }
 349 }
 350
 351 PeerTubeEmbed.main()
 352   .catch(err => {
 353     (window as any).displayIncompatibleBrowser()
 354
 355     logger.error('Cannot init embed.', err)
 356   })