]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/lib/client-html.ts
Process remaining segment hashes on live ending
[github/Chocobozzz/PeerTube.git] / server / lib / client-html.ts
index d8ae73b5de6ea058fe294664be64258f95100e47..7d1d19588881d0f0a2a0ec767aa14dcea1777d6d 100644 (file)
@@ -9,7 +9,7 @@ import {
   FILES_CONTENT_HASH
 } from '../initializers/constants'
 import { join } from 'path'
-import { escapeHTML, sha256 } from '../helpers/core-utils'
+import { escapeHTML, isTestInstance, sha256 } from '../helpers/core-utils'
 import { VideoModel } from '../models/video/video'
 import { VideoPlaylistModel } from '../models/video/video-playlist'
 import validator from 'validator'
@@ -23,6 +23,34 @@ import { CONFIG } from '../initializers/config'
 import { logger } from '../helpers/logger'
 import { MAccountActor, MChannelActor } from '../types/models'
 
+type Tags = {
+  ogType: string
+  twitterCard: 'player' | 'summary' | 'summary_large_image'
+  schemaType: string
+
+  list?: {
+    numberOfItems: number
+  }
+
+  siteName: string
+  title: string
+  url: string
+  description: string
+
+  embed?: {
+    url: string
+    createdAt: string
+    duration?: string
+    views?: number
+  }
+
+  image: {
+    url: string
+    width?: number
+    height?: number
+  }
+}
+
 export class ClientHtml {
 
   private static htmlCache: { [path: string]: string } = {}
@@ -67,6 +95,7 @@ export class ClientHtml {
 
     const url = WEBSERVER.URL + video.getWatchStaticPath()
     const title = escapeHTML(video.name)
+    const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
     const description = escapeHTML(video.description)
 
     const image = {
@@ -84,7 +113,7 @@ export class ClientHtml {
     const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image'
     const schemaType = 'VideoObject'
 
-    customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, embed, ogType, twitterCard, schemaType })
+    customHtml = ClientHtml.addTags(customHtml, { url, siteName, title, description, image, embed, ogType, twitterCard, schemaType })
 
     return customHtml
   }
@@ -112,21 +141,27 @@ export class ClientHtml {
 
     const url = videoPlaylist.getWatchUrl()
     const title = escapeHTML(videoPlaylist.name)
+    const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
     const description = escapeHTML(videoPlaylist.description)
 
     const image = {
       url: videoPlaylist.getThumbnailUrl()
     }
 
+    const embed = {
+      url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(),
+      createdAt: videoPlaylist.createdAt.toISOString()
+    }
+
     const list = {
-      numberOfItems: videoPlaylist.get('videosLength')
+      numberOfItems: videoPlaylist.get('videosLength') as number
     }
 
     const ogType = 'video'
-    const twitterCard = 'summary'
+    const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary'
     const schemaType = 'ItemList'
 
-    customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, list, ogType, twitterCard, schemaType })
+    customHtml = ClientHtml.addTags(customHtml, { url, siteName, embed, title, description, image, list, ogType, twitterCard, schemaType })
 
     return customHtml
   }
@@ -139,6 +174,21 @@ export class ClientHtml {
     return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res)
   }
 
+  static async getEmbedHTML () {
+    const path = ClientHtml.getEmbedPath()
+
+    if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
+
+    const buffer = await readFile(path)
+
+    let html = buffer.toString()
+    html = await ClientHtml.addAsyncPluginCSS(html)
+
+    ClientHtml.htmlCache[path] = html
+
+    return html
+  }
+
   private static async getAccountOrChannelHTMLPage (
     loader: () => Bluebird<MAccountActor | MChannelActor>,
     req: express.Request,
@@ -159,6 +209,7 @@ export class ClientHtml {
     customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(entity.description))
 
     const url = entity.Actor.url
+    const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
     const title = escapeHTML(entity.getDisplayName())
     const description = escapeHTML(entity.description)
 
@@ -172,14 +223,14 @@ export class ClientHtml {
     const twitterCard = 'summary'
     const schemaType = 'ProfilePage'
 
-    customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, ogType, twitterCard, schemaType })
+    customHtml = ClientHtml.addTags(customHtml, { url, title, siteName, description, image, ogType, twitterCard, schemaType })
 
     return customHtml
   }
 
   private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) {
     const path = ClientHtml.getIndexPath(req, res, paramLang)
-    if (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
+    if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
 
     const buffer = await readFile(path)
 
@@ -220,6 +271,10 @@ export class ClientHtml {
     return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
   }
 
+  private static getEmbedPath () {
+    return join(__dirname, '../../../client/dist/standalone/videos/embed.html')
+  }
+
   private static addHtmlLang (htmlStringPage: string, paramLang: string) {
     return htmlStringPage.replace('<html>', `<html lang="${paramLang}">`)
   }
@@ -268,9 +323,10 @@ export class ClientHtml {
     return htmlStringPage.replace('</head>', linkTag + '</head>')
   }
 
-  private static generateOpenGraphMetaTags (tags) {
+  private static generateOpenGraphMetaTags (tags: Tags) {
     const metaTags = {
       'og:type': tags.ogType,
+      'og:site_name': tags.siteName,
       'og:title': tags.title,
       'og:image': tags.image.url
     }
@@ -294,7 +350,7 @@ export class ClientHtml {
     return metaTags
   }
 
-  private static generateStandardMetaTags (tags) {
+  private static generateStandardMetaTags (tags: Tags) {
     return {
       name: tags.title,
       description: tags.description,
@@ -302,7 +358,7 @@ export class ClientHtml {
     }
   }
 
-  private static generateTwitterCardMetaTags (tags) {
+  private static generateTwitterCardMetaTags (tags: Tags) {
     const metaTags = {
       'twitter:card': tags.twitterCard,
       'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
@@ -316,10 +372,16 @@ export class ClientHtml {
       metaTags['twitter:image:height'] = tags.image.height
     }
 
+    if (tags.twitterCard === 'player') {
+      metaTags['twitter:player'] = tags.embed.url
+      metaTags['twitter:player:width'] = EMBED_SIZE.width
+      metaTags['twitter:player:height'] = EMBED_SIZE.height
+    }
+
     return metaTags
   }
 
-  private static generateSchemaTags (tags) {
+  private static generateSchemaTags (tags: Tags) {
     const schema = {
       '@context': 'http://schema.org',
       '@type': tags.schemaType,
@@ -337,8 +399,10 @@ export class ClientHtml {
     if (tags.embed) {
       schema['embedUrl'] = tags.embed.url
       schema['uploadDate'] = tags.embed.createdAt
-      schema['duration'] = tags.embed.duration
-      schema['iterationCount'] = tags.embed.views
+
+      if (tags.embed.duration) schema['duration'] = tags.embed.duration
+      if (tags.embed.views) schema['iterationCount'] = tags.embed.views
+
       schema['thumbnailUrl'] = tags.image.url
       schema['contentUrl'] = tags.url
     }
@@ -346,7 +410,7 @@ export class ClientHtml {
     return schema
   }
 
-  private static addTags (htmlStringPage: string, tagsValues: any) {
+  private static addTags (htmlStringPage: string, tagsValues: Tags) {
     const openGraphMetaTags = this.generateOpenGraphMetaTags(tagsValues)
     const standardMetaTags = this.generateStandardMetaTags(tagsValues)
     const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues)
@@ -354,7 +418,7 @@ export class ClientHtml {
 
     const { url, title, embed } = tagsValues
 
-    const oembedLinkTags = []
+    const oembedLinkTags: { type: string, href: string, title: string }[] = []
 
     if (embed) {
       oembedLinkTags.push({