X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fclient-html.ts;h=4068e3d7b080b6e8a51c44af0045f1e93ae8dc2e;hb=76148b27f7501bac061992136852be4303370c8d;hp=ffe53d0d50d7dcc54b7291aa5cb4719c418ea1c6;hpb=8d987ec63e6888c839ad55938d45809869c517c6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index ffe53d0d5..4068e3d7b 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -1,29 +1,63 @@ import * as express from 'express' -import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n' +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 { ServerConfigManager } from './server-config-manager' + +type Tags = { + ogType: string + twitterCard: 'player' | 'summary' | 'summary_large_image' + schemaType: string + + list?: { + numberOfItems: number + } + + siteName: string + title: string + url: string + originUrl: string + description: string + + embed?: { + url: string + createdAt: string + duration?: string + views?: number + } -export class ClientHtml { + image: { + url: string + width?: number + height?: number + } +} + +class ClientHtml { private static htmlCache: { [path: string]: string } = {} @@ -47,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) } @@ -58,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() @@ -84,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 } @@ -92,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) } @@ -103,44 +150,94 @@ 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() } + 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, + siteName, + embed, + title, + description, + 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, + loader: () => Promise, req: express.Request, res: express.Response ) { @@ -151,37 +248,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 ServerConfigManager.Instance.getHTMLServerConfig() let html = buffer.toString() @@ -190,6 +300,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 @@ -220,6 +331,10 @@ export class ClientHtml { return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html') } + private static getEmbedPath () { + return join(__dirname, '../../../client/dist/standalone/videos/embed.html') + } + private static addHtmlLang (htmlStringPage: string, paramLang: string) { return htmlStringPage.replace('', ``) } @@ -258,6 +373,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 @@ -268,9 +390,10 @@ export class ClientHtml { return htmlStringPage.replace('', linkTag + '') } - private static generateOpenGraphMetaTags (tags) { + 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 } @@ -281,7 +404,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 @@ -294,15 +417,15 @@ export class ClientHtml { return metaTags } - private static generateStandardMetaTags (tags) { + private static generateStandardMetaTags (tags: Tags) { return { name: tags.title, - description: tags.description, + description: mdToPlainText(tags.description), 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, @@ -316,10 +439,16 @@ export class ClientHtml { 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, @@ -337,8 +466,10 @@ export class ClientHtml { 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 } @@ -346,15 +477,15 @@ export class ClientHtml { 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, title, embed, originUrl } = tagsValues - const oembedLinkTags = [] + const oembedLinkTags: { type: string, href: string, title: string }[] = [] if (embed) { oembedLinkTags.push({ @@ -398,8 +529,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.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) +}