]>
Commit | Line | Data |
---|---|---|
e032aec9 | 1 | import * as express from 'express' |
b49f22d8 C |
2 | import { readFile } from 'fs-extra' |
3 | import { join } from 'path' | |
4 | import validator from 'validator' | |
aea0b0e7 C |
5 | import { escapeHTML } from '@shared/core-utils/renderer' |
6 | import { HTMLServerConfig } from '@shared/models' | |
bd45d503 | 7 | import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n' |
b49f22d8 C |
8 | import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes' |
9 | import { VideoPlaylistPrivacy, VideoPrivacy } from '../../shared/models/videos' | |
4097c6d6 | 10 | import { isTestInstance, sha256 } from '../helpers/core-utils' |
b49f22d8 | 11 | import { logger } from '../helpers/logger' |
aea0b0e7 | 12 | import { mdToPlainText } from '../helpers/markdown' |
b49f22d8 | 13 | import { CONFIG } from '../initializers/config' |
8d987ec6 | 14 | import { |
b49f22d8 | 15 | ACCEPT_HEADERS, |
2cb03dc1 | 16 | ACTOR_IMAGES_SIZE, |
8d987ec6 K |
17 | CUSTOM_HTML_TAG_COMMENTS, |
18 | EMBED_SIZE, | |
f2eb23cd | 19 | FILES_CONTENT_HASH, |
b49f22d8 C |
20 | PLUGIN_GLOBAL_CSS_PATH, |
21 | WEBSERVER | |
8d987ec6 | 22 | } from '../initializers/constants' |
92bf2f62 | 23 | import { AccountModel } from '../models/account/account' |
b49f22d8 | 24 | import { VideoModel } from '../models/video/video' |
92bf2f62 | 25 | import { VideoChannelModel } from '../models/video/video-channel' |
b49f22d8 C |
26 | import { getActivityStreamDuration } from '../models/video/video-format-utils' |
27 | import { VideoPlaylistModel } from '../models/video/video-playlist' | |
8d987ec6 | 28 | import { MAccountActor, MChannelActor } from '../types/models' |
2539932e | 29 | import { ServerConfigManager } from './server-config-manager' |
e032aec9 | 30 | |
6fad8e51 C |
31 | type Tags = { |
32 | ogType: string | |
b96777c3 | 33 | twitterCard: 'player' | 'summary' | 'summary_large_image' |
6fad8e51 C |
34 | schemaType: string |
35 | ||
36 | list?: { | |
37 | numberOfItems: number | |
38 | } | |
39 | ||
865af3fd | 40 | siteName: string |
6fad8e51 C |
41 | title: string |
42 | url: string | |
106fa224 | 43 | originUrl: string |
6fad8e51 C |
44 | description: string |
45 | ||
46 | embed?: { | |
47 | url: string | |
48 | createdAt: string | |
49 | duration?: string | |
50 | views?: number | |
51 | } | |
52 | ||
53 | image: { | |
54 | url: string | |
55 | width?: number | |
56 | height?: number | |
57 | } | |
58 | } | |
59 | ||
f2eb23cd | 60 | class ClientHtml { |
e032aec9 | 61 | |
a1587156 | 62 | private static htmlCache: { [path: string]: string } = {} |
e032aec9 C |
63 | |
64 | static invalidCache () { | |
3e753302 C |
65 | logger.info('Cleaning HTML cache.') |
66 | ||
e032aec9 C |
67 | ClientHtml.htmlCache = {} |
68 | } | |
69 | ||
9aac4423 | 70 | static async getDefaultHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { |
7738273b RK |
71 | const html = paramLang |
72 | ? await ClientHtml.getIndexHTML(req, res, paramLang) | |
73 | : await ClientHtml.getIndexHTML(req, res) | |
e032aec9 | 74 | |
9aac4423 C |
75 | let customHtml = ClientHtml.addTitleTag(html) |
76 | customHtml = ClientHtml.addDescriptionTag(customHtml) | |
e032aec9 | 77 | |
9aac4423 | 78 | return customHtml |
e032aec9 C |
79 | } |
80 | ||
81 | static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) { | |
e032aec9 | 82 | // Let Angular application handle errors |
92bf2f62 | 83 | if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) { |
2d53be02 | 84 | res.status(HttpStatusCode.NOT_FOUND_404) |
e032aec9 C |
85 | return ClientHtml.getIndexHTML(req, res) |
86 | } | |
87 | ||
88 | const [ html, video ] = await Promise.all([ | |
89 | ClientHtml.getIndexHTML(req, res), | |
d636ab58 | 90 | VideoModel.loadWithBlacklist(videoId) |
e032aec9 C |
91 | ]) |
92 | ||
93 | // Let Angular application handle errors | |
22a73cb8 | 94 | if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) { |
2d53be02 | 95 | res.status(HttpStatusCode.NOT_FOUND_404) |
c08579e1 | 96 | return html |
e032aec9 C |
97 | } |
98 | ||
9aac4423 | 99 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) |
a073c912 | 100 | customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(video.description)) |
8d987ec6 K |
101 | |
102 | const url = WEBSERVER.URL + video.getWatchStaticPath() | |
106fa224 | 103 | const originUrl = video.url |
8d987ec6 | 104 | const title = escapeHTML(video.name) |
865af3fd | 105 | const siteName = escapeHTML(CONFIG.INSTANCE.NAME) |
a073c912 | 106 | const description = mdToPlainText(video.description) |
8d987ec6 K |
107 | |
108 | const image = { | |
109 | url: WEBSERVER.URL + video.getPreviewStaticPath() | |
110 | } | |
111 | ||
112 | const embed = { | |
113 | url: WEBSERVER.URL + video.getEmbedStaticPath(), | |
114 | createdAt: video.createdAt.toISOString(), | |
115 | duration: getActivityStreamDuration(video.duration), | |
116 | views: video.views | |
117 | } | |
118 | ||
119 | const ogType = 'video' | |
120 | const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image' | |
121 | const schemaType = 'VideoObject' | |
122 | ||
106fa224 | 123 | customHtml = ClientHtml.addTags(customHtml, { |
a59f210f C |
124 | url, |
125 | originUrl, | |
126 | siteName, | |
127 | title, | |
128 | description, | |
129 | image, | |
130 | embed, | |
131 | ogType, | |
132 | twitterCard, | |
133 | schemaType | |
106fa224 | 134 | }) |
8d987ec6 K |
135 | |
136 | return customHtml | |
137 | } | |
138 | ||
139 | static async getWatchPlaylistHTMLPage (videoPlaylistId: string, req: express.Request, res: express.Response) { | |
140 | // Let Angular application handle errors | |
141 | if (!validator.isInt(videoPlaylistId) && !validator.isUUID(videoPlaylistId, 4)) { | |
2d53be02 | 142 | res.status(HttpStatusCode.NOT_FOUND_404) |
8d987ec6 K |
143 | return ClientHtml.getIndexHTML(req, res) |
144 | } | |
145 | ||
146 | const [ html, videoPlaylist ] = await Promise.all([ | |
147 | ClientHtml.getIndexHTML(req, res), | |
148 | VideoPlaylistModel.loadWithAccountAndChannel(videoPlaylistId, null) | |
149 | ]) | |
150 | ||
151 | // Let Angular application handle errors | |
152 | if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) { | |
2d53be02 | 153 | res.status(HttpStatusCode.NOT_FOUND_404) |
8d987ec6 K |
154 | return html |
155 | } | |
156 | ||
157 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name)) | |
a073c912 | 158 | customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(videoPlaylist.description)) |
8d987ec6 K |
159 | |
160 | const url = videoPlaylist.getWatchUrl() | |
106fa224 | 161 | const originUrl = videoPlaylist.url |
8d987ec6 | 162 | const title = escapeHTML(videoPlaylist.name) |
865af3fd | 163 | const siteName = escapeHTML(CONFIG.INSTANCE.NAME) |
a073c912 | 164 | const description = mdToPlainText(videoPlaylist.description) |
8d987ec6 K |
165 | |
166 | const image = { | |
167 | url: videoPlaylist.getThumbnailUrl() | |
168 | } | |
169 | ||
6fad8e51 C |
170 | const embed = { |
171 | url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(), | |
172 | createdAt: videoPlaylist.createdAt.toISOString() | |
173 | } | |
174 | ||
8d987ec6 | 175 | const list = { |
6fad8e51 | 176 | numberOfItems: videoPlaylist.get('videosLength') as number |
8d987ec6 K |
177 | } |
178 | ||
179 | const ogType = 'video' | |
6fad8e51 | 180 | const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary' |
8d987ec6 K |
181 | const schemaType = 'ItemList' |
182 | ||
106fa224 | 183 | customHtml = ClientHtml.addTags(customHtml, { |
a59f210f C |
184 | url, |
185 | originUrl, | |
186 | siteName, | |
187 | embed, | |
188 | title, | |
189 | description, | |
190 | image, | |
191 | list, | |
192 | ogType, | |
193 | twitterCard, | |
194 | schemaType | |
106fa224 | 195 | }) |
92bf2f62 C |
196 | |
197 | return customHtml | |
198 | } | |
199 | ||
200 | static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { | |
9a911038 K |
201 | const accountModelPromise = AccountModel.loadByNameWithHost(nameWithHost) |
202 | return this.getAccountOrChannelHTMLPage(() => accountModelPromise, req, res) | |
92bf2f62 C |
203 | } |
204 | ||
205 | static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { | |
9a911038 K |
206 | const videoChannelModelPromise = VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost) |
207 | return this.getAccountOrChannelHTMLPage(() => videoChannelModelPromise, req, res) | |
208 | } | |
209 | ||
210 | static async getActorHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { | |
012580d9 C |
211 | const [ account, channel ] = await Promise.all([ |
212 | AccountModel.loadByNameWithHost(nameWithHost), | |
213 | VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost) | |
214 | ]) | |
9a911038 | 215 | |
012580d9 | 216 | return this.getAccountOrChannelHTMLPage(() => Promise.resolve(account || channel), req, res) |
92bf2f62 C |
217 | } |
218 | ||
cf649c2e C |
219 | static async getEmbedHTML () { |
220 | const path = ClientHtml.getEmbedPath() | |
cf649c2e | 221 | |
b9da21bd | 222 | if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path] |
cf649c2e C |
223 | |
224 | const buffer = await readFile(path) | |
2539932e | 225 | const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig() |
cf649c2e C |
226 | |
227 | let html = buffer.toString() | |
228 | html = await ClientHtml.addAsyncPluginCSS(html) | |
2564d97e | 229 | html = ClientHtml.addCustomCSS(html) |
915e2bbb | 230 | html = ClientHtml.addTitleTag(html) |
aea0b0e7 C |
231 | html = ClientHtml.addDescriptionTag(html) |
232 | html = ClientHtml.addServerConfig(html, serverConfig) | |
cf649c2e C |
233 | |
234 | ClientHtml.htmlCache[path] = html | |
235 | ||
236 | return html | |
237 | } | |
238 | ||
92bf2f62 | 239 | private static async getAccountOrChannelHTMLPage ( |
b49f22d8 | 240 | loader: () => Promise<MAccountActor | MChannelActor>, |
92bf2f62 C |
241 | req: express.Request, |
242 | res: express.Response | |
243 | ) { | |
244 | const [ html, entity ] = await Promise.all([ | |
245 | ClientHtml.getIndexHTML(req, res), | |
246 | loader() | |
247 | ]) | |
248 | ||
249 | // Let Angular application handle errors | |
250 | if (!entity) { | |
2d53be02 | 251 | res.status(HttpStatusCode.NOT_FOUND_404) |
92bf2f62 C |
252 | return ClientHtml.getIndexHTML(req, res) |
253 | } | |
254 | ||
255 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName())) | |
a073c912 | 256 | customHtml = ClientHtml.addDescriptionTag(customHtml, mdToPlainText(entity.description)) |
8d987ec6 | 257 | |
a59f210f | 258 | const url = entity.getLocalUrl() |
106fa224 | 259 | const originUrl = entity.Actor.url |
865af3fd | 260 | const siteName = escapeHTML(CONFIG.INSTANCE.NAME) |
8d987ec6 | 261 | const title = escapeHTML(entity.getDisplayName()) |
a073c912 | 262 | const description = mdToPlainText(entity.description) |
8d987ec6 K |
263 | |
264 | const image = { | |
265 | url: entity.Actor.getAvatarUrl(), | |
2cb03dc1 C |
266 | width: ACTOR_IMAGES_SIZE.AVATARS.width, |
267 | height: ACTOR_IMAGES_SIZE.AVATARS.height | |
8d987ec6 K |
268 | } |
269 | ||
270 | const ogType = 'website' | |
271 | const twitterCard = 'summary' | |
272 | const schemaType = 'ProfilePage' | |
273 | ||
a59f210f C |
274 | customHtml = ClientHtml.addTags(customHtml, { |
275 | url, | |
276 | originUrl, | |
277 | title, | |
278 | siteName, | |
279 | description, | |
280 | image, | |
281 | ogType, | |
282 | twitterCard, | |
283 | schemaType | |
284 | }) | |
9aac4423 C |
285 | |
286 | return customHtml | |
287 | } | |
288 | ||
289 | private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) { | |
290 | const path = ClientHtml.getIndexPath(req, res, paramLang) | |
b9da21bd | 291 | if (!isTestInstance() && ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path] |
9aac4423 C |
292 | |
293 | const buffer = await readFile(path) | |
2539932e | 294 | const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig() |
9aac4423 C |
295 | |
296 | let html = buffer.toString() | |
297 | ||
7738273b | 298 | if (paramLang) html = ClientHtml.addHtmlLang(html, paramLang) |
caf2aaf4 K |
299 | html = ClientHtml.addManifestContentHash(html) |
300 | html = ClientHtml.addFaviconContentHash(html) | |
301 | html = ClientHtml.addLogoContentHash(html) | |
9aac4423 | 302 | html = ClientHtml.addCustomCSS(html) |
aea0b0e7 | 303 | html = ClientHtml.addServerConfig(html, serverConfig) |
a8b666e9 | 304 | html = await ClientHtml.addAsyncPluginCSS(html) |
9aac4423 | 305 | |
a1587156 | 306 | ClientHtml.htmlCache[path] = html |
9aac4423 C |
307 | |
308 | return html | |
e032aec9 C |
309 | } |
310 | ||
7738273b | 311 | private static getIndexPath (req: express.Request, res: express.Response, paramLang: string) { |
e032aec9 C |
312 | let lang: string |
313 | ||
314 | // Check param lang validity | |
315 | if (paramLang && is18nLocale(paramLang)) { | |
316 | lang = paramLang | |
317 | ||
318 | // Save locale in cookies | |
319 | res.cookie('clientLanguage', lang, { | |
6dd9de95 | 320 | secure: WEBSERVER.SCHEME === 'https', |
bc90883f | 321 | sameSite: 'none', |
e032aec9 C |
322 | maxAge: 1000 * 3600 * 24 * 90 // 3 months |
323 | }) | |
324 | ||
325 | } else if (req.cookies.clientLanguage && is18nLocale(req.cookies.clientLanguage)) { | |
326 | lang = req.cookies.clientLanguage | |
327 | } else { | |
328 | lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale() | |
329 | } | |
330 | ||
331 | return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html') | |
332 | } | |
333 | ||
cf649c2e C |
334 | private static getEmbedPath () { |
335 | return join(__dirname, '../../../client/dist/standalone/videos/embed.html') | |
336 | } | |
337 | ||
7738273b RK |
338 | private static addHtmlLang (htmlStringPage: string, paramLang: string) { |
339 | return htmlStringPage.replace('<html>', `<html lang="${paramLang}">`) | |
340 | } | |
341 | ||
caf2aaf4 K |
342 | private static addManifestContentHash (htmlStringPage: string) { |
343 | return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST) | |
344 | } | |
345 | ||
1fdf8edb | 346 | private static addFaviconContentHash (htmlStringPage: string) { |
caf2aaf4 K |
347 | return htmlStringPage.replace('[faviconContentHash]', FILES_CONTENT_HASH.FAVICON) |
348 | } | |
349 | ||
1fdf8edb | 350 | private static addLogoContentHash (htmlStringPage: string) { |
caf2aaf4 K |
351 | return htmlStringPage.replace('[logoContentHash]', FILES_CONTENT_HASH.LOGO) |
352 | } | |
353 | ||
9aac4423 C |
354 | private static addTitleTag (htmlStringPage: string, title?: string) { |
355 | let text = title || CONFIG.INSTANCE.NAME | |
356 | if (title) text += ` - ${CONFIG.INSTANCE.NAME}` | |
357 | ||
358 | const titleTag = `<title>${text}</title>` | |
e032aec9 C |
359 | |
360 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag) | |
361 | } | |
362 | ||
9aac4423 C |
363 | private static addDescriptionTag (htmlStringPage: string, description?: string) { |
364 | const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION | |
365 | const descriptionTag = `<meta name="description" content="${content}" />` | |
e032aec9 C |
366 | |
367 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag) | |
368 | } | |
369 | ||
370 | private static addCustomCSS (htmlStringPage: string) { | |
ffb321be | 371 | const styleTag = `<style class="custom-css-style">${CONFIG.INSTANCE.CUSTOMIZATIONS.CSS}</style>` |
e032aec9 C |
372 | |
373 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag) | |
374 | } | |
375 | ||
aea0b0e7 C |
376 | private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) { |
377 | const serverConfigString = JSON.stringify(serverConfig) | |
378 | const configScriptTag = `<script type="application/javascript">window.PeerTubeServerConfig = '${serverConfigString}'</script>` | |
379 | ||
380 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.SERVER_CONFIG, configScriptTag) | |
381 | } | |
382 | ||
a8b666e9 C |
383 | private static async addAsyncPluginCSS (htmlStringPage: string) { |
384 | const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH) | |
3e753302 | 385 | if (globalCSSContent.byteLength === 0) return htmlStringPage |
a8b666e9 C |
386 | |
387 | const fileHash = sha256(globalCSSContent) | |
388 | const linkTag = `<link rel="stylesheet" href="/plugins/global.css?hash=${fileHash}" />` | |
ffb321be C |
389 | |
390 | return htmlStringPage.replace('</head>', linkTag + '</head>') | |
391 | } | |
392 | ||
6fad8e51 | 393 | private static generateOpenGraphMetaTags (tags: Tags) { |
8d987ec6 K |
394 | const metaTags = { |
395 | 'og:type': tags.ogType, | |
865af3fd | 396 | 'og:site_name': tags.siteName, |
8d987ec6 K |
397 | 'og:title': tags.title, |
398 | 'og:image': tags.image.url | |
399 | } | |
400 | ||
401 | if (tags.image.width && tags.image.height) { | |
402 | metaTags['og:image:width'] = tags.image.width | |
403 | metaTags['og:image:height'] = tags.image.height | |
404 | } | |
e032aec9 | 405 | |
8d987ec6 | 406 | metaTags['og:url'] = tags.url |
a073c912 | 407 | metaTags['og:description'] = mdToPlainText(tags.description) |
e032aec9 | 408 | |
8d987ec6 K |
409 | if (tags.embed) { |
410 | metaTags['og:video:url'] = tags.embed.url | |
411 | metaTags['og:video:secure_url'] = tags.embed.url | |
412 | metaTags['og:video:type'] = 'text/html' | |
413 | metaTags['og:video:width'] = EMBED_SIZE.width | |
414 | metaTags['og:video:height'] = EMBED_SIZE.height | |
415 | } | |
e032aec9 | 416 | |
8d987ec6 K |
417 | return metaTags |
418 | } | |
e032aec9 | 419 | |
6fad8e51 | 420 | private static generateStandardMetaTags (tags: Tags) { |
8d987ec6 K |
421 | return { |
422 | name: tags.title, | |
a073c912 | 423 | description: mdToPlainText(tags.description), |
8d987ec6 K |
424 | image: tags.image.url |
425 | } | |
426 | } | |
e032aec9 | 427 | |
6fad8e51 | 428 | private static generateTwitterCardMetaTags (tags: Tags) { |
8d987ec6 K |
429 | const metaTags = { |
430 | 'twitter:card': tags.twitterCard, | |
e032aec9 | 431 | 'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME, |
8d987ec6 K |
432 | 'twitter:title': tags.title, |
433 | 'twitter:description': tags.description, | |
434 | 'twitter:image': tags.image.url | |
e032aec9 C |
435 | } |
436 | ||
8d987ec6 K |
437 | if (tags.image.width && tags.image.height) { |
438 | metaTags['twitter:image:width'] = tags.image.width | |
439 | metaTags['twitter:image:height'] = tags.image.height | |
440 | } | |
441 | ||
b96777c3 C |
442 | if (tags.twitterCard === 'player') { |
443 | metaTags['twitter:player'] = tags.embed.url | |
444 | metaTags['twitter:player:width'] = EMBED_SIZE.width | |
445 | metaTags['twitter:player:height'] = EMBED_SIZE.height | |
446 | } | |
447 | ||
8d987ec6 K |
448 | return metaTags |
449 | } | |
e032aec9 | 450 | |
6fad8e51 | 451 | private static generateSchemaTags (tags: Tags) { |
8d987ec6 | 452 | const schema = { |
e032aec9 | 453 | '@context': 'http://schema.org', |
8d987ec6 K |
454 | '@type': tags.schemaType, |
455 | 'name': tags.title, | |
456 | 'description': tags.description, | |
457 | 'image': tags.image.url, | |
458 | 'url': tags.url | |
459 | } | |
460 | ||
461 | if (tags.list) { | |
462 | schema['numberOfItems'] = tags.list.numberOfItems | |
463 | schema['thumbnailUrl'] = tags.image.url | |
464 | } | |
465 | ||
466 | if (tags.embed) { | |
467 | schema['embedUrl'] = tags.embed.url | |
468 | schema['uploadDate'] = tags.embed.createdAt | |
6fad8e51 C |
469 | |
470 | if (tags.embed.duration) schema['duration'] = tags.embed.duration | |
471 | if (tags.embed.views) schema['iterationCount'] = tags.embed.views | |
472 | ||
8d987ec6 K |
473 | schema['thumbnailUrl'] = tags.image.url |
474 | schema['contentUrl'] = tags.url | |
475 | } | |
476 | ||
477 | return schema | |
478 | } | |
479 | ||
6fad8e51 | 480 | private static addTags (htmlStringPage: string, tagsValues: Tags) { |
8d987ec6 K |
481 | const openGraphMetaTags = this.generateOpenGraphMetaTags(tagsValues) |
482 | const standardMetaTags = this.generateStandardMetaTags(tagsValues) | |
483 | const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues) | |
484 | const schemaTags = this.generateSchemaTags(tagsValues) | |
485 | ||
106fa224 | 486 | const { url, title, embed, originUrl } = tagsValues |
8d987ec6 | 487 | |
6fad8e51 | 488 | const oembedLinkTags: { type: string, href: string, title: string }[] = [] |
8d987ec6 K |
489 | |
490 | if (embed) { | |
491 | oembedLinkTags.push({ | |
492 | type: 'application/json+oembed', | |
493 | href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url), | |
494 | title | |
495 | }) | |
e032aec9 C |
496 | } |
497 | ||
498 | let tagsString = '' | |
499 | ||
500 | // Opengraph | |
501 | Object.keys(openGraphMetaTags).forEach(tagName => { | |
a1587156 | 502 | const tagValue = openGraphMetaTags[tagName] |
e032aec9 C |
503 | |
504 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
505 | }) | |
506 | ||
8d987ec6 K |
507 | // Standard |
508 | Object.keys(standardMetaTags).forEach(tagName => { | |
509 | const tagValue = standardMetaTags[tagName] | |
510 | ||
511 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
512 | }) | |
513 | ||
514 | // Twitter card | |
515 | Object.keys(twitterCardMetaTags).forEach(tagName => { | |
516 | const tagValue = twitterCardMetaTags[tagName] | |
517 | ||
518 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
519 | }) | |
520 | ||
e032aec9 C |
521 | // OEmbed |
522 | for (const oembedLinkTag of oembedLinkTags) { | |
523 | tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />` | |
524 | } | |
525 | ||
526 | // Schema.org | |
8d987ec6 K |
527 | if (schemaTags) { |
528 | tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>` | |
529 | } | |
92bf2f62 | 530 | |
8d987ec6 | 531 | // SEO, use origin URL |
106fa224 | 532 | tagsString += `<link rel="canonical" href="${originUrl}" />` |
92bf2f62 | 533 | |
8d987ec6 | 534 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString) |
e032aec9 C |
535 | } |
536 | } | |
f2eb23cd RK |
537 | |
538 | function sendHTML (html: string, res: express.Response) { | |
539 | res.set('Content-Type', 'text/html; charset=UTF-8') | |
540 | ||
541 | return res.send(html) | |
542 | } | |
543 | ||
544 | async function serveIndexHTML (req: express.Request, res: express.Response) { | |
545 | if (req.accepts(ACCEPT_HEADERS) === 'html' || | |
546 | !req.headers.accept) { | |
547 | try { | |
548 | await generateHTMLPage(req, res, req.params.language) | |
549 | return | |
550 | } catch (err) { | |
551 | logger.error('Cannot generate HTML page.', err) | |
76148b27 | 552 | return res.status(HttpStatusCode.INTERNAL_SERVER_ERROR_500).end() |
f2eb23cd RK |
553 | } |
554 | } | |
555 | ||
76148b27 | 556 | return res.status(HttpStatusCode.NOT_ACCEPTABLE_406).end() |
f2eb23cd RK |
557 | } |
558 | ||
559 | // --------------------------------------------------------------------------- | |
560 | ||
561 | export { | |
562 | ClientHtml, | |
563 | sendHTML, | |
564 | serveIndexHTML | |
565 | } | |
566 | ||
567 | async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { | |
568 | const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang) | |
569 | ||
570 | return sendHTML(html, res) | |
571 | } |