X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fclient-html.ts;h=e7e439bfe4bee38fbc00eb38c77fbb329efbe5ec;hb=f304a1580b5ce7b6c5f9e25cd3ddc63ca8d8c6a1;hp=e093d35f733540a4cd2d1e13e53bf62415e7e4e8;hpb=352819ef921e45381b3fbb17072926103b320e73;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index e093d35f7..e7e439bfe 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -1,13 +1,15 @@ -import * as express from 'express' +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 { 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, sha256 } from '../helpers/core-utils' +import { isTestInstance } from '../helpers/core-utils' import { logger } from '../helpers/logger' import { mdToPlainText } from '../helpers/markdown' import { CONFIG } from '../initializers/config' @@ -27,7 +29,6 @@ import { VideoChannelModel } from '../models/video/video-channel' import { VideoPlaylistModel } from '../models/video/video-playlist' import { MAccountActor, MChannelActor } from '../types/models' import { ServerConfigManager } from './server-config-manager' -import { toCompleteUUID } from '@server/helpers/custom-validators/misc' type Tags = { ogType: string @@ -38,11 +39,12 @@ type Tags = { numberOfItems: number } - siteName: string - title: string + escapedSiteName: string + escapedTitle: string + escapedDescription: string + url: string originUrl: string - description: string disallowIndexation?: boolean @@ -100,15 +102,15 @@ class ClientHtml { res.status(HttpStatusCode.NOT_FOUND_404) return html } + const description = mdToPlainText(video.description) - let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) - customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(video.description)) + let customHtml = ClientHtml.addTitleTag(html, video.name) + customHtml = ClientHtml.addDescriptionTag(customHtml, description) const url = WEBSERVER.URL + video.getWatchStaticPath() const originUrl = video.url - const title = escapeHTML(video.name) - const siteName = escapeHTML(CONFIG.INSTANCE.NAME) - const description = mdToPlainText(video.description) + const title = video.name + const siteName = CONFIG.INSTANCE.NAME const image = { url: WEBSERVER.URL + video.getPreviewStaticPath() @@ -128,9 +130,9 @@ class ClientHtml { customHtml = ClientHtml.addTags(customHtml, { url, originUrl, - siteName, - title, - description, + escapedSiteName: escapeHTML(siteName), + escapedTitle: escapeHTML(title), + escapedDescription: escapeHTML(description), image, embed, ogType, @@ -161,14 +163,15 @@ class ClientHtml { return html } - let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name)) - customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(videoPlaylist.description)) + const description = mdToPlainText(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 = escapeHTML(videoPlaylist.name) - const siteName = escapeHTML(CONFIG.INSTANCE.NAME) - const description = mdToPlainText(videoPlaylist.description) + const title = videoPlaylist.name + const siteName = CONFIG.INSTANCE.NAME const image = { url: videoPlaylist.getThumbnailUrl() @@ -190,10 +193,10 @@ class ClientHtml { customHtml = ClientHtml.addTags(customHtml, { url, originUrl, - siteName, + escapedSiteName: escapeHTML(siteName), + escapedTitle: escapeHTML(title), + escapedDescription: escapeHTML(description), embed, - title, - description, image, list, ogType, @@ -259,14 +262,15 @@ class ClientHtml { return ClientHtml.getIndexHTML(req, res) } - let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName())) - customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(entity.description)) + const description = mdToPlainText(entity.description) + + let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName()) + customHtml = ClientHtml.addDescriptionTag(customHtml, description) const url = entity.getLocalUrl() const originUrl = entity.Actor.url - const siteName = escapeHTML(CONFIG.INSTANCE.NAME) - const title = escapeHTML(entity.getDisplayName()) - const description = mdToPlainText(entity.description) + const siteName = CONFIG.INSTANCE.NAME + const title = entity.getDisplayName() const image = { url: entity.Actor.getAvatarUrl(), @@ -281,9 +285,9 @@ class ClientHtml { customHtml = ClientHtml.addTags(customHtml, { url, originUrl, - title, - siteName, - description, + escapedTitle: escapeHTML(title), + escapedSiteName: escapeHTML(siteName), + escapedDescription: escapeHTML(description), image, ogType, twitterCard, @@ -303,7 +307,6 @@ class ClientHtml { let html = buffer.toString() - if (paramLang) html = ClientHtml.addHtmlLang(html, paramLang) html = ClientHtml.addManifestContentHash(html) html = ClientHtml.addFaviconContentHash(html) html = ClientHtml.addLogoContentHash(html) @@ -336,6 +339,11 @@ class ClientHtml { lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale() } + logger.debug( + 'Serving %s HTML language', buildFileLocale(lang), + { cookie: req.cookies?.clientLanguage, paramLang, acceptLanguage: req.headers['accept-language'] } + ) + return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html') } @@ -343,10 +351,6 @@ class ClientHtml { return join(__dirname, '../../../client/dist/standalone/videos/embed.html') } - private static addHtmlLang (htmlStringPage: string, paramLang: string) { - return htmlStringPage.replace('', ``) - } - private static addManifestContentHash (htmlStringPage: string) { return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST) } @@ -363,14 +367,14 @@ class ClientHtml { let text = title || CONFIG.INSTANCE.NAME if (title) text += ` - ${CONFIG.INSTANCE.NAME}` - const titleTag = `${text}` + const titleTag = `${escapeHTML(text)}` 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 = `` + const descriptionTag = `` return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag) } @@ -382,8 +386,9 @@ class ClientHtml { } private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) { - const serverConfigString = JSON.stringify(serverConfig) - const configScriptTag = `` + // 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 = `` return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.SERVER_CONFIG, configScriptTag) } @@ -401,8 +406,8 @@ class ClientHtml { private static generateOpenGraphMetaTags (tags: Tags) { const metaTags = { 'og:type': tags.ogType, - 'og:site_name': tags.siteName, - 'og:title': tags.title, + 'og:site_name': tags.escapedSiteName, + 'og:title': tags.escapedTitle, 'og:image': tags.image.url } @@ -412,7 +417,7 @@ class ClientHtml { } metaTags['og:url'] = tags.url - metaTags['og:description'] = mdToPlainText(tags.description) + metaTags['og:description'] = tags.escapedDescription if (tags.embed) { metaTags['og:video:url'] = tags.embed.url @@ -427,8 +432,8 @@ class ClientHtml { private static generateStandardMetaTags (tags: Tags) { return { - name: tags.title, - description: mdToPlainText(tags.description), + name: tags.escapedTitle, + description: tags.escapedDescription, image: tags.image.url } } @@ -437,8 +442,8 @@ class ClientHtml { 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 } @@ -460,8 +465,8 @@ class ClientHtml { 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 } @@ -491,71 +496,74 @@ class ClientHtml { const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues) const schemaTags = this.generateSchemaTags(tagsValues) - const { url, title, embed, originUrl, disallowIndexation } = tagsValues + const { url, escapedTitle, embed, originUrl, disallowIndexation } = tagsValues - const oembedLinkTags: { type: string, href: string, title: string }[] = [] + 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 += `` + tagsStr += `` }) // Standard Object.keys(standardMetaTags).forEach(tagName => { const tagValue = standardMetaTags[tagName] - tagsString += `` + tagsStr += `` }) // Twitter card Object.keys(twitterCardMetaTags).forEach(tagName => { const tagValue = twitterCardMetaTags[tagName] - tagsString += `` + tagsStr += `` }) // OEmbed for (const oembedLinkTag of oembedLinkTags) { - tagsString += `` + tagsStr += `` } // Schema.org if (schemaTags) { - tagsString += `` + tagsStr += `` } // SEO, use origin URL - tagsString += `` + tagsStr += `` if (disallowIndexation) { - tagsString += `` + tagsStr += `` } - return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString) + return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsStr) } } -function sendHTML (html: string, res: express.Response) { +function sendHTML (html: string, res: express.Response, localizedHTML: boolean = false) { res.set('Content-Type', 'text/html; charset=UTF-8') + 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) { + if (req.accepts(ACCEPT_HEADERS) === 'html' || !req.headers.accept) { try { await generateHTMLPage(req, res, req.params.language) return @@ -579,5 +587,5 @@ export { async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang) - return sendHTML(html, res) + return sendHTML(html, res, true) }