PeerTube/server/lib/client-html.ts

254 lines
9.0 KiB
TypeScript
Raw Normal View History

import * as express from 'express'
import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n'
2019-07-23 09:48:48 +02:00
import { CUSTOM_HTML_TAG_COMMENTS, EMBED_SIZE, PLUGIN_GLOBAL_CSS_PATH, WEBSERVER } from '../initializers/constants'
import { join } from 'path'
2019-07-23 09:48:48 +02:00
import { escapeHTML, sha256 } from '../helpers/core-utils'
import { VideoModel } from '../models/video/video'
2020-01-07 14:56:07 +01:00
import validator from 'validator'
import { VideoPrivacy } from '../../shared/models/videos'
2018-08-27 16:23:34 +02:00
import { readFile } from 'fs-extra'
import { getActivityStreamDuration } from '../models/video/video-format-utils'
2019-02-21 14:06:10 +01:00
import { AccountModel } from '../models/account/account'
import { VideoChannelModel } from '../models/video/video-channel'
import * as Bluebird from 'bluebird'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2019-07-23 10:40:39 +02:00
import { logger } from '../helpers/logger'
2019-08-15 11:53:26 +02:00
import { MAccountActor, MChannelActor, MVideo } from '../typings/models'
export class ClientHtml {
2019-02-21 14:06:10 +01:00
private static htmlCache: { [ path: string ]: string } = {}
static invalidCache () {
2019-07-23 10:40:39 +02:00
logger.info('Cleaning HTML cache.')
ClientHtml.htmlCache = {}
}
static async getDefaultHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
const html = await ClientHtml.getIndexHTML(req, res, paramLang)
let customHtml = ClientHtml.addTitleTag(html)
customHtml = ClientHtml.addDescriptionTag(customHtml)
return customHtml
}
static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) {
// Let Angular application handle errors
2019-02-21 14:06:10 +01:00
if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) {
2020-01-09 08:50:00 +01:00
res.status(404)
return ClientHtml.getIndexHTML(req, res)
}
const [ html, video ] = await Promise.all([
ClientHtml.getIndexHTML(req, res),
2019-08-22 10:46:54 +02:00
VideoModel.loadWithBlacklist(videoId)
])
// Let Angular application handle errors
2019-12-12 15:47:47 +01:00
if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) {
2020-01-09 08:50:00 +01:00
res.status(404)
return html
}
let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name))
customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description))
2019-02-21 14:06:10 +01:00
customHtml = ClientHtml.addVideoOpenGraphAndOEmbedTags(customHtml, video)
return customHtml
}
static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
return this.getAccountOrChannelHTMLPage(() => AccountModel.loadByNameWithHost(nameWithHost), req, res)
}
static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res)
}
private static async getAccountOrChannelHTMLPage (
2019-08-15 11:53:26 +02:00
loader: () => Bluebird<MAccountActor | MChannelActor>,
2019-02-21 14:06:10 +01:00
req: express.Request,
res: express.Response
) {
const [ html, entity ] = await Promise.all([
ClientHtml.getIndexHTML(req, res),
loader()
])
// Let Angular application handle errors
if (!entity) {
2020-01-09 08:50:00 +01:00
res.status(404)
2019-02-21 14:06:10 +01:00
return ClientHtml.getIndexHTML(req, res)
}
let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName()))
customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(entity.description))
customHtml = ClientHtml.addAccountOrChannelMetaTags(customHtml, entity)
return customHtml
}
private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) {
const path = ClientHtml.getIndexPath(req, res, paramLang)
2019-02-21 14:06:10 +01:00
if (ClientHtml.htmlCache[ path ]) return ClientHtml.htmlCache[ path ]
const buffer = await readFile(path)
let html = buffer.toString()
html = ClientHtml.addCustomCSS(html)
2019-07-23 09:48:48 +02:00
html = await ClientHtml.addAsyncPluginCSS(html)
2019-02-21 14:06:10 +01:00
ClientHtml.htmlCache[ path ] = html
return html
}
private static getIndexPath (req: express.Request, res: express.Response, paramLang?: string) {
let lang: string
// Check param lang validity
if (paramLang && is18nLocale(paramLang)) {
lang = paramLang
// Save locale in cookies
res.cookie('clientLanguage', lang, {
2019-04-11 11:33:44 +02:00
secure: WEBSERVER.SCHEME === 'https',
sameSite: true,
maxAge: 1000 * 3600 * 24 * 90 // 3 months
})
} else if (req.cookies.clientLanguage && is18nLocale(req.cookies.clientLanguage)) {
lang = req.cookies.clientLanguage
} else {
lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale()
}
return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
}
private static addTitleTag (htmlStringPage: string, title?: string) {
let text = title || CONFIG.INSTANCE.NAME
if (title) text += ` - ${CONFIG.INSTANCE.NAME}`
const titleTag = `<title>${text}</title>`
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag)
}
private static addDescriptionTag (htmlStringPage: string, description?: string) {
const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION
const descriptionTag = `<meta name="description" content="${content}" />`
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
}
private static addCustomCSS (htmlStringPage: string) {
2019-07-10 14:06:19 +02:00
const styleTag = `<style class="custom-css-style">${CONFIG.INSTANCE.CUSTOMIZATIONS.CSS}</style>`
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag)
}
2019-07-23 09:48:48 +02:00
private static async addAsyncPluginCSS (htmlStringPage: string) {
const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH)
2019-07-23 10:40:39 +02:00
if (globalCSSContent.byteLength === 0) return htmlStringPage
2019-07-23 09:48:48 +02:00
const fileHash = sha256(globalCSSContent)
const linkTag = `<link rel="stylesheet" href="/plugins/global.css?hash=${fileHash}" />`
2019-07-10 14:06:19 +02:00
return htmlStringPage.replace('</head>', linkTag + '</head>')
}
2019-08-15 11:53:26 +02:00
private static addVideoOpenGraphAndOEmbedTags (htmlStringPage: string, video: MVideo) {
2019-04-11 11:33:44 +02:00
const previewUrl = WEBSERVER.URL + video.getPreviewStaticPath()
const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
const videoNameEscaped = escapeHTML(video.name)
const videoDescriptionEscaped = escapeHTML(video.description)
2019-04-11 11:33:44 +02:00
const embedUrl = WEBSERVER.URL + video.getEmbedStaticPath()
const openGraphMetaTags = {
'og:type': 'video',
'og:title': videoNameEscaped,
'og:image': previewUrl,
'og:url': videoUrl,
'og:description': videoDescriptionEscaped,
'og:video:url': embedUrl,
'og:video:secure_url': embedUrl,
2018-11-14 08:18:50 +01:00
'og:video:type': 'text/html',
'og:video:width': EMBED_SIZE.width,
'og:video:height': EMBED_SIZE.height,
'name': videoNameEscaped,
'description': videoDescriptionEscaped,
'image': previewUrl,
'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image',
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
'twitter:title': videoNameEscaped,
'twitter:description': videoDescriptionEscaped,
'twitter:image': previewUrl,
'twitter:player': embedUrl,
'twitter:player:width': EMBED_SIZE.width,
'twitter:player:height': EMBED_SIZE.height
}
const oembedLinkTags = [
{
type: 'application/json+oembed',
2019-04-11 11:33:44 +02:00
href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl),
title: videoNameEscaped
}
]
const schemaTags = {
'@context': 'http://schema.org',
'@type': 'VideoObject',
name: videoNameEscaped,
description: videoDescriptionEscaped,
thumbnailUrl: previewUrl,
uploadDate: video.createdAt.toISOString(),
duration: getActivityStreamDuration(video.duration),
contentUrl: videoUrl,
embedUrl: embedUrl,
interactionCount: video.views
}
let tagsString = ''
// Opengraph
Object.keys(openGraphMetaTags).forEach(tagName => {
2019-02-21 14:06:10 +01:00
const tagValue = openGraphMetaTags[ tagName ]
tagsString += `<meta property="${tagName}" content="${tagValue}" />`
})
// OEmbed
for (const oembedLinkTag of oembedLinkTags) {
tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
}
// Schema.org
tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
2019-01-10 16:00:23 +01:00
// SEO, use origin video url so Google does not index remote videos
tagsString += `<link rel="canonical" href="${video.url}" />`
2019-02-21 14:06:10 +01:00
return this.addOpenGraphAndOEmbedTags(htmlStringPage, tagsString)
}
2019-08-15 11:53:26 +02:00
private static addAccountOrChannelMetaTags (htmlStringPage: string, entity: MAccountActor | MChannelActor) {
2019-02-21 14:06:10 +01:00
// SEO, use origin account or channel URL
const metaTags = `<link rel="canonical" href="${entity.Actor.url}" />`
return this.addOpenGraphAndOEmbedTags(htmlStringPage, metaTags)
}
private static addOpenGraphAndOEmbedTags (htmlStringPage: string, metaTags: string) {
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, metaTags)
}
}