X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fclient-html.ts;h=926d6e93f40f67243cfac4918df5ce8f1b32f985;hb=2199aaef6fcf37411dba401475be36c89eb325d3;hp=516827a054f926ae0a77c22bf0bafe2491784470;hpb=74dc3bca2b14f5fd3fe80c394dfc34177a46db77;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index 516827a05..926d6e93f 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -1,28 +1,69 @@ import * as express from 'express' -import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n' -import { CUSTOM_HTML_TAG_COMMENTS, EMBED_SIZE, WEBSERVER } from '../initializers/constants' +import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n' +import { + AVATARS_SIZE, + CUSTOM_HTML_TAG_COMMENTS, + EMBED_SIZE, + PLUGIN_GLOBAL_CSS_PATH, + WEBSERVER, + FILES_CONTENT_HASH +} from '../initializers/constants' import { join } from 'path' -import { escapeHTML } from '../helpers/core-utils' +import { escapeHTML, sha256 } from '../helpers/core-utils' import { VideoModel } from '../models/video/video' -import * as validator from 'validator' -import { VideoPrivacy } from '../../shared/models/videos' +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 { VideoChannelModel } from '../models/video/video-channel' import * as Bluebird from 'bluebird' import { CONFIG } from '../initializers/config' +import { logger } from '../helpers/logger' +import { MAccountActor, MChannelActor } from '../types/models' + +type Tags = { + ogType: string + twitterCard: 'player' | 'summary' | 'summary_large_image' + schemaType: string + + list?: { + numberOfItems: number + } + + title: string + url: string + description: string + + embed?: { + url: string + createdAt: string + duration?: string + views?: number + } + + image: { + url: string + width?: number + height?: number + } +} export class ClientHtml { - private static htmlCache: { [ path: string ]: string } = {} + private static htmlCache: { [path: string]: string } = {} static invalidCache () { + 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) + const html = paramLang + ? await ClientHtml.getIndexHTML(req, res, paramLang) + : await ClientHtml.getIndexHTML(req, res) let customHtml = ClientHtml.addTitleTag(html) customHtml = ClientHtml.addDescriptionTag(customHtml) @@ -33,22 +74,91 @@ 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) return ClientHtml.getIndexHTML(req, res) } const [ html, video ] = await Promise.all([ ClientHtml.getIndexHTML(req, res), - VideoModel.loadAndPopulateAccountAndServerAndTags(videoId) + VideoModel.loadWithBlacklist(videoId) ]) // Let Angular application handle errors - if (!video || video.privacy === VideoPrivacy.PRIVATE) { - return ClientHtml.getIndexHTML(req, res) + if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) { + res.status(404) + return html } let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description)) - customHtml = ClientHtml.addVideoOpenGraphAndOEmbedTags(customHtml, video) + + const url = WEBSERVER.URL + video.getWatchStaticPath() + const title = escapeHTML(video.name) + const description = escapeHTML(video.description) + + const image = { + url: WEBSERVER.URL + video.getPreviewStaticPath() + } + + const embed = { + url: WEBSERVER.URL + video.getEmbedStaticPath(), + createdAt: video.createdAt.toISOString(), + duration: getActivityStreamDuration(video.duration), + views: video.views + } + + const ogType = 'video' + 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 }) + + return customHtml + } + + 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) + return ClientHtml.getIndexHTML(req, res) + } + + const [ html, videoPlaylist ] = await Promise.all([ + ClientHtml.getIndexHTML(req, res), + VideoPlaylistModel.loadWithAccountAndChannel(videoPlaylistId, null) + ]) + + // Let Angular application handle errors + if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) { + res.status(404) + return html + } + + let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name)) + customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(videoPlaylist.description)) + + const url = videoPlaylist.getWatchUrl() + const title = escapeHTML(videoPlaylist.name) + const description = escapeHTML(videoPlaylist.description) + + const image = { + url: videoPlaylist.getThumbnailUrl() + } + + const embed = { + url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(), + createdAt: videoPlaylist.createdAt.toISOString() + } + + const list = { + numberOfItems: videoPlaylist.get('videosLength') as number + } + + const ogType = 'video' + const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary' + const schemaType = 'ItemList' + + customHtml = ClientHtml.addTags(customHtml, { url, embed, title, description, image, list, ogType, twitterCard, schemaType }) return customHtml } @@ -61,8 +171,23 @@ export class ClientHtml { return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res) } + static async getEmbedHTML () { + const path = ClientHtml.getEmbedPath() + + if (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path] + + const buffer = await readFile(path) + + let html = buffer.toString() + html = await ClientHtml.addAsyncPluginCSS(html) + + ClientHtml.htmlCache[path] = html + + return html + } + private static async getAccountOrChannelHTMLPage ( - loader: () => Bluebird, + loader: () => Bluebird, req: express.Request, res: express.Response ) { @@ -73,32 +198,53 @@ export class ClientHtml { // Let Angular application handle errors if (!entity) { + res.status(404) 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) + + const url = entity.Actor.url + const title = escapeHTML(entity.getDisplayName()) + const description = escapeHTML(entity.description) + + const image = { + url: entity.Actor.getAvatarUrl(), + width: AVATARS_SIZE.width, + height: AVATARS_SIZE.height + } + + const ogType = 'website' + const twitterCard = 'summary' + const schemaType = 'ProfilePage' + + customHtml = ClientHtml.addTags(customHtml, { url, title, 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 (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path] const buffer = await readFile(path) 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 = await ClientHtml.addAsyncPluginCSS(html) - ClientHtml.htmlCache[ path ] = html + ClientHtml.htmlCache[path] = html return html } - private static getIndexPath (req: express.Request, res: express.Response, paramLang?: string) { + private static getIndexPath (req: express.Request, res: express.Response, paramLang: string) { let lang: string // Check param lang validity @@ -108,7 +254,7 @@ export class ClientHtml { // Save locale in cookies res.cookie('clientLanguage', lang, { secure: WEBSERVER.SCHEME === 'https', - sameSite: true, + sameSite: 'none', maxAge: 1000 * 3600 * 24 * 90 // 3 months }) @@ -121,6 +267,26 @@ 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('', ``) + } + + private static addManifestContentHash (htmlStringPage: string) { + return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST) + } + + private static addFaviconContentHash (htmlStringPage: string) { + return htmlStringPage.replace('[faviconContentHash]', FILES_CONTENT_HASH.FAVICON) + } + + private static addLogoContentHash (htmlStringPage: string) { + return htmlStringPage.replace('[logoContentHash]', FILES_CONTENT_HASH.LOGO) + } + private static addTitleTag (htmlStringPage: string, title?: string) { let text = title || CONFIG.INSTANCE.NAME if (title) text += ` - ${CONFIG.INSTANCE.NAME}` @@ -138,72 +304,144 @@ export class ClientHtml { } private static addCustomCSS (htmlStringPage: string) { - const styleTag = '' + const styleTag = `` return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag) } - private static addVideoOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) { - const previewUrl = WEBSERVER.URL + video.getPreviewStaticPath() - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() + private static async addAsyncPluginCSS (htmlStringPage: string) { + const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH) + if (globalCSSContent.byteLength === 0) return htmlStringPage - const videoNameEscaped = escapeHTML(video.name) - const videoDescriptionEscaped = escapeHTML(video.description) - const embedUrl = WEBSERVER.URL + video.getEmbedStaticPath() + const fileHash = sha256(globalCSSContent) + const linkTag = `` - const openGraphMetaTags = { - 'og:type': 'video', - 'og:title': videoNameEscaped, - 'og:image': previewUrl, - 'og:url': videoUrl, - 'og:description': videoDescriptionEscaped, + return htmlStringPage.replace('', linkTag + '') + } - 'og:video:url': embedUrl, - 'og:video:secure_url': embedUrl, - 'og:video:type': 'text/html', - 'og:video:width': EMBED_SIZE.width, - 'og:video:height': EMBED_SIZE.height, + private static generateOpenGraphMetaTags (tags: Tags) { + const metaTags = { + 'og:type': tags.ogType, + 'og:title': tags.title, + 'og:image': tags.image.url + } - 'name': videoNameEscaped, - 'description': videoDescriptionEscaped, - 'image': previewUrl, + if (tags.image.width && tags.image.height) { + metaTags['og:image:width'] = tags.image.width + metaTags['og:image:height'] = tags.image.height + } + + metaTags['og:url'] = tags.url + metaTags['og:description'] = tags.description - 'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image', + if (tags.embed) { + metaTags['og:video:url'] = tags.embed.url + metaTags['og:video:secure_url'] = tags.embed.url + metaTags['og:video:type'] = 'text/html' + metaTags['og:video:width'] = EMBED_SIZE.width + metaTags['og:video:height'] = EMBED_SIZE.height + } + + return metaTags + } + + private static generateStandardMetaTags (tags: Tags) { + return { + name: tags.title, + description: tags.description, + image: tags.image.url + } + } + + private static generateTwitterCardMetaTags (tags: Tags) { + const metaTags = { + 'twitter:card': tags.twitterCard, '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 + 'twitter:title': tags.title, + 'twitter:description': tags.description, + 'twitter:image': tags.image.url } - const oembedLinkTags = [ - { - type: 'application/json+oembed', - href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl), - title: videoNameEscaped - } - ] + if (tags.image.width && tags.image.height) { + metaTags['twitter:image:width'] = tags.image.width + 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 + } - const schemaTags = { + return metaTags + } + + private static generateSchemaTags (tags: Tags) { + const schema = { '@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 + '@type': tags.schemaType, + 'name': tags.title, + 'description': tags.description, + 'image': tags.image.url, + 'url': tags.url + } + + if (tags.list) { + schema['numberOfItems'] = tags.list.numberOfItems + schema['thumbnailUrl'] = tags.image.url + } + + if (tags.embed) { + schema['embedUrl'] = tags.embed.url + schema['uploadDate'] = tags.embed.createdAt + + 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: 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 oembedLinkTags: { type: string, href: string, title: string }[] = [] + + if (embed) { + oembedLinkTags.push({ + type: 'application/json+oembed', + href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url), + title + }) } let tagsString = '' // Opengraph Object.keys(openGraphMetaTags).forEach(tagName => { - const tagValue = openGraphMetaTags[ tagName ] + const tagValue = openGraphMetaTags[tagName] + + tagsString += `` + }) + + // Standard + Object.keys(standardMetaTags).forEach(tagName => { + const tagValue = standardMetaTags[tagName] + + tagsString += `` + }) + + // Twitter card + Object.keys(twitterCardMetaTags).forEach(tagName => { + const tagValue = twitterCardMetaTags[tagName] tagsString += `` }) @@ -214,22 +452,13 @@ export class ClientHtml { } // Schema.org - tagsString += `` - - // SEO, use origin video url so Google does not index remote videos - tagsString += `` - - return this.addOpenGraphAndOEmbedTags(htmlStringPage, tagsString) - } - - private static addAccountOrChannelMetaTags (htmlStringPage: string, entity: AccountModel | VideoChannelModel) { - // SEO, use origin account or channel URL - const metaTags = `` + if (schemaTags) { + tagsString += `` + } - return this.addOpenGraphAndOEmbedTags(htmlStringPage, metaTags) - } + // SEO, use origin URL + tagsString += `` - private static addOpenGraphAndOEmbedTags (htmlStringPage: string, metaTags: string) { - return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, metaTags) + return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString) } }