-import * as express from 'express'
-import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n'
+import express from 'express'
+import { readFile } from 'fs-extra'
+import { join } from 'path'
+import validator from 'validator'
+import { toCompleteUUID } from '@server/helpers/custom-validators/misc'
+import { root } from '@shared/core-utils'
+import { escapeHTML } from '@shared/core-utils/renderer'
+import { sha256 } from '@shared/extra-utils'
+import { HTMLServerConfig } from '@shared/models'
+import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n'
+import { HttpStatusCode } from '../../shared/models/http/http-error-codes'
+import { VideoPlaylistPrivacy, VideoPrivacy } from '../../shared/models/videos'
+import { isTestInstance } from '../helpers/core-utils'
+import { logger } from '../helpers/logger'
+import { mdToOneLinePlainText } from '../helpers/markdown'
+import { CONFIG } from '../initializers/config'
import {
- AVATARS_SIZE,
+ ACCEPT_HEADERS,
+ ACTOR_IMAGES_SIZE,
CUSTOM_HTML_TAG_COMMENTS,
EMBED_SIZE,
+ FILES_CONTENT_HASH,
PLUGIN_GLOBAL_CSS_PATH,
- WEBSERVER,
- FILES_CONTENT_HASH
+ WEBSERVER
} from '../initializers/constants'
-import { join } from 'path'
-import { escapeHTML, sha256 } from '../helpers/core-utils'
-import { VideoModel } from '../models/video/video'
-import { VideoPlaylistModel } from '../models/video/video-playlist'
-import validator from 'validator'
-import { VideoPrivacy, VideoPlaylistPrivacy } from '../../shared/models/videos'
-import { readFile } from 'fs-extra'
-import { getActivityStreamDuration } from '../models/video/video-format-utils'
import { AccountModel } from '../models/account/account'
+import { getActivityStreamDuration } from '../models/video/formatter/video-format-utils'
+import { VideoModel } from '../models/video/video'
import { VideoChannelModel } from '../models/video/video-channel'
-import * as Bluebird from 'bluebird'
-import { CONFIG } from '../initializers/config'
-import { logger } from '../helpers/logger'
+import { VideoPlaylistModel } from '../models/video/video-playlist'
import { MAccountActor, MChannelActor } from '../types/models'
+import { ServerConfigManager } from './server-config-manager'
+
+type Tags = {
+ ogType: string
+ twitterCard: 'player' | 'summary' | 'summary_large_image'
+ schemaType: string
+
+ list?: {
+ numberOfItems: number
+ }
+
+ escapedSiteName: string
+ escapedTitle: string
+ escapedDescription: string
+
+ url: string
+ originUrl: string
+
+ disallowIndexation?: boolean
-export class ClientHtml {
+ embed?: {
+ url: string
+ createdAt: string
+ duration?: string
+ views?: number
+ }
+
+ image: {
+ url: string
+ width?: number
+ height?: number
+ }
+}
+
+class ClientHtml {
private static htmlCache: { [path: string]: string } = {}
return customHtml
}
- static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) {
+ static async getWatchHTMLPage (videoIdArg: string, req: express.Request, res: express.Response) {
+ const videoId = toCompleteUUID(videoIdArg)
+
// Let Angular application handle errors
if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) {
- res.status(404)
+ res.status(HttpStatusCode.NOT_FOUND_404)
return ClientHtml.getIndexHTML(req, res)
}
// Let Angular application handle errors
if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) {
- res.status(404)
+ res.status(HttpStatusCode.NOT_FOUND_404)
return html
}
+ const description = mdToOneLinePlainText(video.description)
- let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name))
- customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description))
+ let customHtml = ClientHtml.addTitleTag(html, video.name)
+ customHtml = ClientHtml.addDescriptionTag(customHtml, description)
const url = WEBSERVER.URL + video.getWatchStaticPath()
- const title = escapeHTML(video.name)
- const description = escapeHTML(video.description)
+ const originUrl = video.url
+ const title = video.name
+ const siteName = CONFIG.INSTANCE.NAME
const image = {
url: WEBSERVER.URL + video.getPreviewStaticPath()
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,
+ originUrl,
+ escapedSiteName: escapeHTML(siteName),
+ escapedTitle: escapeHTML(title),
+ escapedDescription: escapeHTML(description),
+ image,
+ embed,
+ ogType,
+ twitterCard,
+ schemaType
+ })
return customHtml
}
- static async getWatchPlaylistHTMLPage (videoPlaylistId: string, req: express.Request, res: express.Response) {
+ static async getWatchPlaylistHTMLPage (videoPlaylistIdArg: string, req: express.Request, res: express.Response) {
+ const videoPlaylistId = toCompleteUUID(videoPlaylistIdArg)
+
// Let Angular application handle errors
if (!validator.isInt(videoPlaylistId) && !validator.isUUID(videoPlaylistId, 4)) {
- res.status(404)
+ res.status(HttpStatusCode.NOT_FOUND_404)
return ClientHtml.getIndexHTML(req, res)
}
// Let Angular application handle errors
if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
- res.status(404)
+ res.status(HttpStatusCode.NOT_FOUND_404)
return html
}
- let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name))
- customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(videoPlaylist.description))
+ const description = mdToOneLinePlainText(videoPlaylist.description)
- const url = videoPlaylist.getWatchUrl()
- const title = escapeHTML(videoPlaylist.name)
- const description = escapeHTML(videoPlaylist.description)
+ let customHtml = ClientHtml.addTitleTag(html, videoPlaylist.name)
+ customHtml = ClientHtml.addDescriptionTag(customHtml, description)
+
+ const url = WEBSERVER.URL + videoPlaylist.getWatchStaticPath()
+ const originUrl = videoPlaylist.url
+ const title = videoPlaylist.name
+ const siteName = CONFIG.INSTANCE.NAME
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,
+ originUrl,
+ escapedSiteName: escapeHTML(siteName),
+ escapedTitle: escapeHTML(title),
+ escapedDescription: escapeHTML(description),
+ embed,
+ image,
+ list,
+ ogType,
+ twitterCard,
+ schemaType
+ })
return customHtml
}
static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
- return this.getAccountOrChannelHTMLPage(() => AccountModel.loadByNameWithHost(nameWithHost), req, res)
+ const accountModelPromise = AccountModel.loadByNameWithHost(nameWithHost)
+ return this.getAccountOrChannelHTMLPage(() => accountModelPromise, req, res)
}
static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
- return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res)
+ const videoChannelModelPromise = VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost)
+ return this.getAccountOrChannelHTMLPage(() => videoChannelModelPromise, req, res)
+ }
+
+ static async getActorHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
+ const [ account, channel ] = await Promise.all([
+ AccountModel.loadByNameWithHost(nameWithHost),
+ VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost)
+ ])
+
+ return this.getAccountOrChannelHTMLPage(() => Promise.resolve(account || channel), req, res)
+ }
+
+ static async getEmbedHTML () {
+ const path = ClientHtml.getEmbedPath()
+
+ if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
+
+ const buffer = await readFile(path)
+ const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig()
+
+ let html = buffer.toString()
+ html = await ClientHtml.addAsyncPluginCSS(html)
+ html = ClientHtml.addCustomCSS(html)
+ html = ClientHtml.addTitleTag(html)
+ html = ClientHtml.addDescriptionTag(html)
+ html = ClientHtml.addServerConfig(html, serverConfig)
+
+ ClientHtml.htmlCache[path] = html
+
+ return html
}
private static async getAccountOrChannelHTMLPage (
- loader: () => Bluebird<MAccountActor | MChannelActor>,
+ loader: () => Promise<MAccountActor | MChannelActor>,
req: express.Request,
res: express.Response
) {
// Let Angular application handle errors
if (!entity) {
- res.status(404)
+ res.status(HttpStatusCode.NOT_FOUND_404)
return ClientHtml.getIndexHTML(req, res)
}
- let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName()))
- customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(entity.description))
+ const description = mdToOneLinePlainText(entity.description)
+
+ let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName())
+ customHtml = ClientHtml.addDescriptionTag(customHtml, description)
- const url = entity.Actor.url
- const title = escapeHTML(entity.getDisplayName())
- const description = escapeHTML(entity.description)
+ const url = entity.getLocalUrl()
+ const originUrl = entity.Actor.url
+ const siteName = CONFIG.INSTANCE.NAME
+ const title = entity.getDisplayName()
const image = {
url: entity.Actor.getAvatarUrl(),
- width: AVATARS_SIZE.width,
- height: AVATARS_SIZE.height
+ width: ACTOR_IMAGES_SIZE.AVATARS.width,
+ height: ACTOR_IMAGES_SIZE.AVATARS.height
}
const ogType = 'website'
const twitterCard = 'summary'
const schemaType = 'ProfilePage'
- customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, ogType, twitterCard, schemaType })
+ customHtml = ClientHtml.addTags(customHtml, {
+ url,
+ originUrl,
+ escapedTitle: escapeHTML(title),
+ escapedSiteName: escapeHTML(siteName),
+ escapedDescription: escapeHTML(description),
+ image,
+ ogType,
+ twitterCard,
+ schemaType,
+ disallowIndexation: !entity.Actor.isOwned()
+ })
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)
+ const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig()
let html = buffer.toString()
- if (paramLang) html = ClientHtml.addHtmlLang(html, paramLang)
html = ClientHtml.addManifestContentHash(html)
html = ClientHtml.addFaviconContentHash(html)
html = ClientHtml.addLogoContentHash(html)
html = ClientHtml.addCustomCSS(html)
+ html = ClientHtml.addServerConfig(html, serverConfig)
html = await ClientHtml.addAsyncPluginCSS(html)
ClientHtml.htmlCache[path] = html
lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale()
}
- return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
+ logger.debug(
+ 'Serving %s HTML language', buildFileLocale(lang),
+ { cookie: req.cookies?.clientLanguage, paramLang, acceptLanguage: req.headers['accept-language'] }
+ )
+
+ return join(root(), 'client', 'dist', buildFileLocale(lang), 'index.html')
}
- private static addHtmlLang (htmlStringPage: string, paramLang: string) {
- return htmlStringPage.replace('<html>', `<html lang="${paramLang}">`)
+ private static getEmbedPath () {
+ return join(root(), 'client', 'dist', 'standalone', 'videos', 'embed.html')
}
private static addManifestContentHash (htmlStringPage: string) {
let text = title || CONFIG.INSTANCE.NAME
if (title) text += ` - ${CONFIG.INSTANCE.NAME}`
- const titleTag = `<title>${text}</title>`
+ const titleTag = `<title>${escapeHTML(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}" />`
+ const descriptionTag = `<meta name="description" content="${escapeHTML(content)}" />`
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
}
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag)
}
+ private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) {
+ // Stringify the JSON object, and then stringify the string object so we can inject it into the HTML
+ const serverConfigString = JSON.stringify(JSON.stringify(serverConfig))
+ const configScriptTag = `<script type="application/javascript">window.PeerTubeServerConfig = ${serverConfigString}</script>`
+
+ return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.SERVER_CONFIG, configScriptTag)
+ }
+
private static async addAsyncPluginCSS (htmlStringPage: string) {
const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH)
if (globalCSSContent.byteLength === 0) return htmlStringPage
return htmlStringPage.replace('</head>', linkTag + '</head>')
}
- private static generateOpenGraphMetaTags (tags) {
+ private static generateOpenGraphMetaTags (tags: Tags) {
const metaTags = {
'og:type': tags.ogType,
- 'og:title': tags.title,
+ 'og:site_name': tags.escapedSiteName,
+ 'og:title': tags.escapedTitle,
'og:image': tags.image.url
}
}
metaTags['og:url'] = tags.url
- metaTags['og:description'] = tags.description
+ metaTags['og:description'] = tags.escapedDescription
if (tags.embed) {
metaTags['og:video:url'] = tags.embed.url
return metaTags
}
- private static generateStandardMetaTags (tags) {
+ private static generateStandardMetaTags (tags: Tags) {
return {
- name: tags.title,
- description: tags.description,
+ name: tags.escapedTitle,
+ description: tags.escapedDescription,
image: tags.image.url
}
}
- private static generateTwitterCardMetaTags (tags) {
+ private static generateTwitterCardMetaTags (tags: Tags) {
const metaTags = {
'twitter:card': tags.twitterCard,
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
- 'twitter:title': tags.title,
- 'twitter:description': tags.description,
+ 'twitter:title': tags.escapedTitle,
+ 'twitter:description': tags.escapedDescription,
'twitter:image': tags.image.url
}
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,
- 'name': tags.title,
- 'description': tags.description,
+ 'name': tags.escapedTitle,
+ 'description': tags.escapedDescription,
'image': tags.image.url,
'url': tags.url
}
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
}
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)
const schemaTags = this.generateSchemaTags(tagsValues)
- const { url, title, embed } = tagsValues
+ const { url, escapedTitle, embed, originUrl, disallowIndexation } = tagsValues
- const oembedLinkTags = []
+ const oembedLinkTags: { type: string, href: string, escapedTitle: string }[] = []
if (embed) {
oembedLinkTags.push({
type: 'application/json+oembed',
href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url),
- title
+ escapedTitle
})
}
- let tagsString = ''
+ let tagsStr = ''
// Opengraph
Object.keys(openGraphMetaTags).forEach(tagName => {
const tagValue = openGraphMetaTags[tagName]
- tagsString += `<meta property="${tagName}" content="${tagValue}" />`
+ tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
})
// Standard
Object.keys(standardMetaTags).forEach(tagName => {
const tagValue = standardMetaTags[tagName]
- tagsString += `<meta property="${tagName}" content="${tagValue}" />`
+ tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
})
// Twitter card
Object.keys(twitterCardMetaTags).forEach(tagName => {
const tagValue = twitterCardMetaTags[tagName]
- tagsString += `<meta property="${tagName}" content="${tagValue}" />`
+ tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
})
// OEmbed
for (const oembedLinkTag of oembedLinkTags) {
- tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
+ tagsStr += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.escapedTitle}" />`
}
// Schema.org
if (schemaTags) {
- tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
+ tagsStr += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
}
// SEO, use origin URL
- tagsString += `<link rel="canonical" href="${url}" />`
+ tagsStr += `<link rel="canonical" href="${originUrl}" />`
+
+ if (disallowIndexation) {
+ tagsStr += `<meta name="robots" content="noindex" />`
+ }
+
+ return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsStr)
+ }
+}
+
+function sendHTML (html: string, res: express.Response, localizedHTML: boolean = false) {
+ res.set('Content-Type', 'text/html; charset=UTF-8')
- return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString)
+ if (localizedHTML) {
+ res.set('Vary', 'Accept-Language')
}
+
+ return res.send(html)
+}
+
+async function serveIndexHTML (req: express.Request, res: express.Response) {
+ if (req.accepts(ACCEPT_HEADERS) === 'html' || !req.headers.accept) {
+ try {
+ await generateHTMLPage(req, res, req.params.language)
+ return
+ } catch (err) {
+ logger.error('Cannot generate HTML page.', err)
+ return res.status(HttpStatusCode.INTERNAL_SERVER_ERROR_500).end()
+ }
+ }
+
+ return res.status(HttpStatusCode.NOT_ACCEPTABLE_406).end()
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+ ClientHtml,
+ sendHTML,
+ serveIndexHTML
+}
+
+async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
+ const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
+
+ return sendHTML(html, res, true)
}
projects / github / Chocobozzz / PeerTube.git / blobdiff