server/lib/client-html.ts

   1 import * as express from 'express'
   2 import { readFile } from 'fs-extra'
   3 import { join } from 'path'
   4 import validator from 'validator'
   5 import { escapeHTML } from '@shared/core-utils/renderer'
   6 import { HTMLServerConfig } from '@shared/models'
   7 import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n'
   8 import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes'
   9 import { VideoPlaylistPrivacy, VideoPrivacy } from '../../shared/models/videos'
  10 import { isTestInstance, sha256 } from '../helpers/core-utils'
  11 import { logger } from '../helpers/logger'
  12 import { mdToPlainText } from '../helpers/markdown'
  13 import { CONFIG } from '../initializers/config'
  14 import {
  15   ACCEPT_HEADERS,
  16   ACTOR_IMAGES_SIZE,
  17   CUSTOM_HTML_TAG_COMMENTS,
  18   EMBED_SIZE,
  19   FILES_CONTENT_HASH,
  20   PLUGIN_GLOBAL_CSS_PATH,
  21   WEBSERVER
  22 } from '../initializers/constants'
  23 import { AccountModel } from '../models/account/account'
  24 import { VideoModel } from '../models/video/video'
  25 import { VideoChannelModel } from '../models/video/video-channel'
  26 import { getActivityStreamDuration } from '../models/video/video-format-utils'
  27 import { VideoPlaylistModel } from '../models/video/video-playlist'
  28 import { MAccountActor, MChannelActor } from '../types/models'
  29 import { getHTMLServerConfig } from './config'
  30
  31 type Tags = {
  32   ogType: string
  33   twitterCard: 'player' | 'summary' | 'summary_large_image'
  34   schemaType: string
  35
  36   list?: {
  37     numberOfItems: number
  38   }
  39
  40   siteName: string
  41   title: string
  42   url: string
  43   originUrl: string
  44   description: string
  45
  46   embed?: {
  47     url: string
  48     createdAt: string
  49     duration?: string
  50     views?: number
  51   }
  52
  53   image: {
  54     url: string
  55     width?: number
  56     height?: number
  57   }
  58 }
  59
  60 class ClientHtml {
  61
  62   private static htmlCache: { [path: string]: string } = {}
  63
  64   static invalidCache () {
  65     logger.info('Cleaning HTML cache.')
  66
  67     ClientHtml.htmlCache = {}
  68   }
  69
  70   static async getDefaultHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
  71     const html = paramLang
  72       ? await ClientHtml.getIndexHTML(req, res, paramLang)
  73       : await ClientHtml.getIndexHTML(req, res)
  74
  75     let customHtml = ClientHtml.addTitleTag(html)
  76     customHtml = ClientHtml.addDescriptionTag(customHtml)
  77
  78     return customHtml
  79   }
  80
  81   static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) {
  82     // Let Angular application handle errors
  83     if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) {
  84       res.status(HttpStatusCode.NOT_FOUND_404)
  85       return ClientHtml.getIndexHTML(req, res)
  86     }
  87
  88     const [ html, video ] = await Promise.all([
  89       ClientHtml.getIndexHTML(req, res),
  90       VideoModel.loadWithBlacklist(videoId)
  91     ])
  92
  93     // Let Angular application handle errors
  94     if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) {
  95       res.status(HttpStatusCode.NOT_FOUND_404)
  96       return html
  97     }
  98
  99     let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name))
 100     customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(video.description))
 101
 102     const url = WEBSERVER.URL + video.getWatchStaticPath()
 103     const originUrl = video.url
 104     const title = escapeHTML(video.name)
 105     const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
 106     const description = mdToPlainText(video.description)
 107
 108     const image = {
 109       url: WEBSERVER.URL + video.getPreviewStaticPath()
 110     }
 111
 112     const embed = {
 113       url: WEBSERVER.URL + video.getEmbedStaticPath(),
 114       createdAt: video.createdAt.toISOString(),
 115       duration: getActivityStreamDuration(video.duration),
 116       views: video.views
 117     }
 118
 119     const ogType = 'video'
 120     const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image'
 121     const schemaType = 'VideoObject'
 122
 123     customHtml = ClientHtml.addTags(customHtml, {
 124       url,
 125       originUrl,
 126       siteName,
 127       title,
 128       description,
 129       image,
 130       embed,
 131       ogType,
 132       twitterCard,
 133       schemaType
 134     })
 135
 136     return customHtml
 137   }
 138
 139   static async getWatchPlaylistHTMLPage (videoPlaylistId: string, req: express.Request, res: express.Response) {
 140     // Let Angular application handle errors
 141     if (!validator.isInt(videoPlaylistId) && !validator.isUUID(videoPlaylistId, 4)) {
 142       res.status(HttpStatusCode.NOT_FOUND_404)
 143       return ClientHtml.getIndexHTML(req, res)
 144     }
 145
 146     const [ html, videoPlaylist ] = await Promise.all([
 147       ClientHtml.getIndexHTML(req, res),
 148       VideoPlaylistModel.loadWithAccountAndChannel(videoPlaylistId, null)
 149     ])
 150
 151     // Let Angular application handle errors
 152     if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
 153       res.status(HttpStatusCode.NOT_FOUND_404)
 154       return html
 155     }
 156
 157     let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name))
 158     customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(videoPlaylist.description))
 159
 160     const url = videoPlaylist.getWatchUrl()
 161     const originUrl = videoPlaylist.url
 162     const title = escapeHTML(videoPlaylist.name)
 163     const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
 164     const description = mdToPlainText(videoPlaylist.description)
 165
 166     const image = {
 167       url: videoPlaylist.getThumbnailUrl()
 168     }
 169
 170     const embed = {
 171       url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(),
 172       createdAt: videoPlaylist.createdAt.toISOString()
 173     }
 174
 175     const list = {
 176       numberOfItems: videoPlaylist.get('videosLength') as number
 177     }
 178
 179     const ogType = 'video'
 180     const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary'
 181     const schemaType = 'ItemList'
 182
 183     customHtml = ClientHtml.addTags(customHtml, {
 184       url,
 185       originUrl,
 186       siteName,
 187       embed,
 188       title,
 189       description,
 190       image,
 191       list,
 192       ogType,
 193       twitterCard,
 194       schemaType
 195     })
 196
 197     return customHtml
 198   }
 199
 200   static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
 201     return this.getAccountOrChannelHTMLPage(() => AccountModel.loadByNameWithHost(nameWithHost), req, res)
 202   }
 203
 204   static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
 205     return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res)
 206   }
 207
 208   static async getEmbedHTML () {
 209     const path = ClientHtml.getEmbedPath()
 210
 211     if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
 212
 213     const buffer = await readFile(path)
 214     const serverConfig = await getHTMLServerConfig()
 215
 216     let html = buffer.toString()
 217     html = await ClientHtml.addAsyncPluginCSS(html)
 218     html = ClientHtml.addCustomCSS(html)
 219     html = ClientHtml.addTitleTag(html)
 220     html = ClientHtml.addDescriptionTag(html)
 221     html = ClientHtml.addServerConfig(html, serverConfig)
 222
 223     ClientHtml.htmlCache[path] = html
 224
 225     return html
 226   }
 227
 228   private static async getAccountOrChannelHTMLPage (
 229     loader: () => Promise<MAccountActor | MChannelActor>,
 230     req: express.Request,
 231     res: express.Response
 232   ) {
 233     const [ html, entity ] = await Promise.all([
 234       ClientHtml.getIndexHTML(req, res),
 235       loader()
 236     ])
 237
 238     // Let Angular application handle errors
 239     if (!entity) {
 240       res.status(HttpStatusCode.NOT_FOUND_404)
 241       return ClientHtml.getIndexHTML(req, res)
 242     }
 243
 244     let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName()))
 245     customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(entity.description))
 246
 247     const url = entity.getLocalUrl()
 248     const originUrl = entity.Actor.url
 249     const siteName = escapeHTML(CONFIG.INSTANCE.NAME)
 250     const title = escapeHTML(entity.getDisplayName())
 251     const description = mdToPlainText(entity.description)
 252
 253     const image = {
 254       url: entity.Actor.getAvatarUrl(),
 255       width: ACTOR_IMAGES_SIZE.AVATARS.width,
 256       height: ACTOR_IMAGES_SIZE.AVATARS.height
 257     }
 258
 259     const ogType = 'website'
 260     const twitterCard = 'summary'
 261     const schemaType = 'ProfilePage'
 262
 263     customHtml = ClientHtml.addTags(customHtml, {
 264       url,
 265       originUrl,
 266       title,
 267       siteName,
 268       description,
 269       image,
 270       ogType,
 271       twitterCard,
 272       schemaType
 273     })
 274
 275     return customHtml
 276   }
 277
 278   private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) {
 279     const path = ClientHtml.getIndexPath(req, res, paramLang)
 280     if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
 281
 282     const buffer = await readFile(path)
 283     const serverConfig = await getHTMLServerConfig()
 284
 285     let html = buffer.toString()
 286
 287     if (paramLang) html = ClientHtml.addHtmlLang(html, paramLang)
 288     html = ClientHtml.addManifestContentHash(html)
 289     html = ClientHtml.addFaviconContentHash(html)
 290     html = ClientHtml.addLogoContentHash(html)
 291     html = ClientHtml.addCustomCSS(html)
 292     html = ClientHtml.addServerConfig(html, serverConfig)
 293     html = await ClientHtml.addAsyncPluginCSS(html)
 294
 295     ClientHtml.htmlCache[path] = html
 296
 297     return html
 298   }
 299
 300   private static getIndexPath (req: express.Request, res: express.Response, paramLang: string) {
 301     let lang: string
 302
 303     // Check param lang validity
 304     if (paramLang && is18nLocale(paramLang)) {
 305       lang = paramLang
 306
 307       // Save locale in cookies
 308       res.cookie('clientLanguage', lang, {
 309         secure: WEBSERVER.SCHEME === 'https',
 310         sameSite: 'none',
 311         maxAge: 1000 * 3600 * 24 * 90 // 3 months
 312       })
 313
 314     } else if (req.cookies.clientLanguage && is18nLocale(req.cookies.clientLanguage)) {
 315       lang = req.cookies.clientLanguage
 316     } else {
 317       lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale()
 318     }
 319
 320     return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
 321   }
 322
 323   private static getEmbedPath () {
 324     return join(__dirname, '../../../client/dist/standalone/videos/embed.html')
 325   }
 326
 327   private static addHtmlLang (htmlStringPage: string, paramLang: string) {
 328     return htmlStringPage.replace('<html>', `<html lang="${paramLang}">`)
 329   }
 330
 331   private static addManifestContentHash (htmlStringPage: string) {
 332     return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST)
 333   }
 334
 335   private static addFaviconContentHash (htmlStringPage: string) {
 336     return htmlStringPage.replace('[faviconContentHash]', FILES_CONTENT_HASH.FAVICON)
 337   }
 338
 339   private static addLogoContentHash (htmlStringPage: string) {
 340     return htmlStringPage.replace('[logoContentHash]', FILES_CONTENT_HASH.LOGO)
 341   }
 342
 343   private static addTitleTag (htmlStringPage: string, title?: string) {
 344     let text = title || CONFIG.INSTANCE.NAME
 345     if (title) text += ` - ${CONFIG.INSTANCE.NAME}`
 346
 347     const titleTag = `<title>${text}</title>`
 348
 349     return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag)
 350   }
 351
 352   private static addDescriptionTag (htmlStringPage: string, description?: string) {
 353     const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION
 354     const descriptionTag = `<meta name="description" content="${content}" />`
 355
 356     return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
 357   }
 358
 359   private static addCustomCSS (htmlStringPage: string) {
 360     const styleTag = `<style class="custom-css-style">${CONFIG.INSTANCE.CUSTOMIZATIONS.CSS}</style>`
 361
 362     return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag)
 363   }
 364
 365   private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) {
 366     const serverConfigString = JSON.stringify(serverConfig)
 367     const configScriptTag = `<script type="application/javascript">window.PeerTubeServerConfig = '${serverConfigString}'</script>`
 368
 369     return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.SERVER_CONFIG, configScriptTag)
 370   }
 371
 372   private static async addAsyncPluginCSS (htmlStringPage: string) {
 373     const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH)
 374     if (globalCSSContent.byteLength === 0) return htmlStringPage
 375
 376     const fileHash = sha256(globalCSSContent)
 377     const linkTag = `<link rel="stylesheet" href="/plugins/global.css?hash=${fileHash}" />`
 378
 379     return htmlStringPage.replace('</head>', linkTag + '</head>')
 380   }
 381
 382   private static generateOpenGraphMetaTags (tags: Tags) {
 383     const metaTags = {
 384       'og:type': tags.ogType,
 385       'og:site_name': tags.siteName,
 386       'og:title': tags.title,
 387       'og:image': tags.image.url
 388     }
 389
 390     if (tags.image.width && tags.image.height) {
 391       metaTags['og:image:width'] = tags.image.width
 392       metaTags['og:image:height'] = tags.image.height
 393     }
 394
 395     metaTags['og:url'] = tags.url
 396     metaTags['og:description'] = mdToPlainText(tags.description)
 397
 398     if (tags.embed) {
 399       metaTags['og:video:url'] = tags.embed.url
 400       metaTags['og:video:secure_url'] = tags.embed.url
 401       metaTags['og:video:type'] = 'text/html'
 402       metaTags['og:video:width'] = EMBED_SIZE.width
 403       metaTags['og:video:height'] = EMBED_SIZE.height
 404     }
 405
 406     return metaTags
 407   }
 408
 409   private static generateStandardMetaTags (tags: Tags) {
 410     return {
 411       name: tags.title,
 412       description: mdToPlainText(tags.description),
 413       image: tags.image.url
 414     }
 415   }
 416
 417   private static generateTwitterCardMetaTags (tags: Tags) {
 418     const metaTags = {
 419       'twitter:card': tags.twitterCard,
 420       'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
 421       'twitter:title': tags.title,
 422       'twitter:description': tags.description,
 423       'twitter:image': tags.image.url
 424     }
 425
 426     if (tags.image.width && tags.image.height) {
 427       metaTags['twitter:image:width'] = tags.image.width
 428       metaTags['twitter:image:height'] = tags.image.height
 429     }
 430
 431     if (tags.twitterCard === 'player') {
 432       metaTags['twitter:player'] = tags.embed.url
 433       metaTags['twitter:player:width'] = EMBED_SIZE.width
 434       metaTags['twitter:player:height'] = EMBED_SIZE.height
 435     }
 436
 437     return metaTags
 438   }
 439
 440   private static generateSchemaTags (tags: Tags) {
 441     const schema = {
 442       '@context': 'http://schema.org',
 443       '@type': tags.schemaType,
 444       'name': tags.title,
 445       'description': tags.description,
 446       'image': tags.image.url,
 447       'url': tags.url
 448     }
 449
 450     if (tags.list) {
 451       schema['numberOfItems'] = tags.list.numberOfItems
 452       schema['thumbnailUrl'] = tags.image.url
 453     }
 454
 455     if (tags.embed) {
 456       schema['embedUrl'] = tags.embed.url
 457       schema['uploadDate'] = tags.embed.createdAt
 458
 459       if (tags.embed.duration) schema['duration'] = tags.embed.duration
 460       if (tags.embed.views) schema['iterationCount'] = tags.embed.views
 461
 462       schema['thumbnailUrl'] = tags.image.url
 463       schema['contentUrl'] = tags.url
 464     }
 465
 466     return schema
 467   }
 468
 469   private static addTags (htmlStringPage: string, tagsValues: Tags) {
 470     const openGraphMetaTags = this.generateOpenGraphMetaTags(tagsValues)
 471     const standardMetaTags = this.generateStandardMetaTags(tagsValues)
 472     const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues)
 473     const schemaTags = this.generateSchemaTags(tagsValues)
 474
 475     const { url, title, embed, originUrl } = tagsValues
 476
 477     const oembedLinkTags: { type: string, href: string, title: string }[] = []
 478
 479     if (embed) {
 480       oembedLinkTags.push({
 481         type: 'application/json+oembed',
 482         href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url),
 483         title
 484       })
 485     }
 486
 487     let tagsString = ''
 488
 489     // Opengraph
 490     Object.keys(openGraphMetaTags).forEach(tagName => {
 491       const tagValue = openGraphMetaTags[tagName]
 492
 493       tagsString += `<meta property="${tagName}" content="${tagValue}" />`
 494     })
 495
 496     // Standard
 497     Object.keys(standardMetaTags).forEach(tagName => {
 498       const tagValue = standardMetaTags[tagName]
 499
 500       tagsString += `<meta property="${tagName}" content="${tagValue}" />`
 501     })
 502
 503     // Twitter card
 504     Object.keys(twitterCardMetaTags).forEach(tagName => {
 505       const tagValue = twitterCardMetaTags[tagName]
 506
 507       tagsString += `<meta property="${tagName}" content="${tagValue}" />`
 508     })
 509
 510     // OEmbed
 511     for (const oembedLinkTag of oembedLinkTags) {
 512       tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
 513     }
 514
 515     // Schema.org
 516     if (schemaTags) {
 517       tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
 518     }
 519
 520     // SEO, use origin URL
 521     tagsString += `<link rel="canonical" href="${originUrl}" />`
 522
 523     return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString)
 524   }
 525 }
 526
 527 function sendHTML (html: string, res: express.Response) {
 528   res.set('Content-Type', 'text/html; charset=UTF-8')
 529
 530   return res.send(html)
 531 }
 532
 533 async function serveIndexHTML (req: express.Request, res: express.Response) {
 534   if (req.accepts(ACCEPT_HEADERS) === 'html' ||
 535       !req.headers.accept) {
 536     try {
 537       await generateHTMLPage(req, res, req.params.language)
 538       return
 539     } catch (err) {
 540       logger.error('Cannot generate HTML page.', err)
 541       return res.sendStatus(HttpStatusCode.INTERNAL_SERVER_ERROR_500)
 542     }
 543   }
 544
 545   return res.sendStatus(HttpStatusCode.NOT_ACCEPTABLE_406)
 546 }
 547
 548 // ---------------------------------------------------------------------------
 549
 550 export {
 551   ClientHtml,
 552   sendHTML,
 553   serveIndexHTML
 554 }
 555
 556 async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
 557   const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
 558
 559   return sendHTML(html, res)
 560 }