X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fclient-html.ts;h=85fdc87545ab98324254304d9a62cfa9c8ec83fb;hb=35f676e5d3e5e242e84ed63da2cc78117079c7cb;hp=926d6e93f40f67243cfac4918df5ce8f1b32f985;hpb=2199aaef6fcf37411dba401475be36c89eb325d3;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index 926d6e93f..85fdc8754 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -1,27 +1,32 @@ import * as express from 'express' +import { readFile } from 'fs-extra' +import { join } from 'path' +import validator from 'validator' +import { escapeHTML } from '@shared/core-utils/renderer' +import { HTMLServerConfig } from '@shared/models' import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n' +import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes' +import { VideoPlaylistPrivacy, VideoPrivacy } from '../../shared/models/videos' +import { isTestInstance, sha256 } from '../helpers/core-utils' +import { logger } from '../helpers/logger' +import { mdToPlainText } 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 { 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 { getActivityStreamDuration } from '../models/video/video-format-utils' +import { VideoPlaylistModel } from '../models/video/video-playlist' import { MAccountActor, MChannelActor } from '../types/models' +import { getHTMLServerConfig } from './config' type Tags = { ogType: string @@ -32,8 +37,10 @@ type Tags = { numberOfItems: number } + siteName: string title: string url: string + originUrl: string description: string embed?: { @@ -50,7 +57,7 @@ type Tags = { } } -export class ClientHtml { +class ClientHtml { private static htmlCache: { [path: string]: string } = {} @@ -74,7 +81,7 @@ export class ClientHtml { static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) { // 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) } @@ -85,16 +92,18 @@ export class ClientHtml { // 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 } let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) - customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description)) + customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(video.description)) const url = WEBSERVER.URL + video.getWatchStaticPath() + const originUrl = video.url const title = escapeHTML(video.name) - const description = escapeHTML(video.description) + const siteName = escapeHTML(CONFIG.INSTANCE.NAME) + const description = mdToPlainText(video.description) const image = { url: WEBSERVER.URL + video.getPreviewStaticPath() @@ -111,7 +120,18 @@ 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, + originUrl, + siteName, + title, + description, + image, + embed, + ogType, + twitterCard, + schemaType + }) return customHtml } @@ -119,7 +139,7 @@ export class ClientHtml { static async getWatchPlaylistHTMLPage (videoPlaylistId: string, req: express.Request, res: express.Response) { // 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) } @@ -130,16 +150,18 @@ export class ClientHtml { // 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)) + customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(videoPlaylist.description)) const url = videoPlaylist.getWatchUrl() + const originUrl = videoPlaylist.url const title = escapeHTML(videoPlaylist.name) - const description = escapeHTML(videoPlaylist.description) + const siteName = escapeHTML(CONFIG.INSTANCE.NAME) + const description = mdToPlainText(videoPlaylist.description) const image = { url: videoPlaylist.getThumbnailUrl() @@ -158,7 +180,19 @@ export class ClientHtml { const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary' const schemaType = 'ItemList' - customHtml = ClientHtml.addTags(customHtml, { url, embed, title, description, image, list, ogType, twitterCard, schemaType }) + customHtml = ClientHtml.addTags(customHtml, { + url, + originUrl, + siteName, + embed, + title, + description, + image, + list, + ogType, + twitterCard, + schemaType + }) return customHtml } @@ -174,12 +208,17 @@ export class ClientHtml { static async getEmbedHTML () { const path = ClientHtml.getEmbedPath() - 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 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 @@ -187,7 +226,7 @@ export class ClientHtml { } private static async getAccountOrChannelHTMLPage ( - loader: () => Bluebird, + loader: () => Promise, req: express.Request, res: express.Response ) { @@ -198,37 +237,50 @@ export class ClientHtml { // 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)) + customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(entity.description)) - const url = entity.Actor.url + const url = entity.getLocalUrl() + const originUrl = entity.Actor.url + const siteName = escapeHTML(CONFIG.INSTANCE.NAME) const title = escapeHTML(entity.getDisplayName()) - const description = escapeHTML(entity.description) + const description = mdToPlainText(entity.description) 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, + 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) + const serverConfig = await getHTMLServerConfig() let html = buffer.toString() @@ -237,6 +289,7 @@ export class ClientHtml { 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 @@ -309,6 +362,13 @@ export class ClientHtml { return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag) } + private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) { + const serverConfigString = JSON.stringify(serverConfig) + const configScriptTag = `` + + 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 @@ -322,6 +382,7 @@ export class ClientHtml { 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 } @@ -332,7 +393,7 @@ export class ClientHtml { } metaTags['og:url'] = tags.url - metaTags['og:description'] = tags.description + metaTags['og:description'] = mdToPlainText(tags.description) if (tags.embed) { metaTags['og:video:url'] = tags.embed.url @@ -348,7 +409,7 @@ export class ClientHtml { private static generateStandardMetaTags (tags: Tags) { return { name: tags.title, - description: tags.description, + description: mdToPlainText(tags.description), image: tags.image.url } } @@ -411,7 +472,7 @@ export class ClientHtml { const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues) const schemaTags = this.generateSchemaTags(tagsValues) - const { url, title, embed } = tagsValues + const { url, title, embed, originUrl } = tagsValues const oembedLinkTags: { type: string, href: string, title: string }[] = [] @@ -457,8 +518,43 @@ export class ClientHtml { } // SEO, use origin URL - tagsString += `` + tagsString += `` return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString) } } + +function sendHTML (html: string, res: express.Response) { + res.set('Content-Type', 'text/html; charset=UTF-8') + + 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.sendStatus(HttpStatusCode.INTERNAL_SERVER_ERROR_500) + } + } + + return res.sendStatus(HttpStatusCode.NOT_ACCEPTABLE_406) +} + +// --------------------------------------------------------------------------- + +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) +}