]>
Commit | Line | Data |
---|---|---|
1 | import * as express from 'express' | |
2 | import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n' | |
3 | import { | |
4 | AVATARS_SIZE, | |
5 | CUSTOM_HTML_TAG_COMMENTS, | |
6 | EMBED_SIZE, | |
7 | PLUGIN_GLOBAL_CSS_PATH, | |
8 | WEBSERVER, | |
9 | FILES_CONTENT_HASH | |
10 | } from '../initializers/constants' | |
11 | import { join } from 'path' | |
12 | import { escapeHTML, sha256 } from '../helpers/core-utils' | |
13 | import { VideoModel } from '../models/video/video' | |
14 | import { VideoPlaylistModel } from '../models/video/video-playlist' | |
15 | import validator from 'validator' | |
16 | import { VideoPrivacy, VideoPlaylistPrivacy } from '../../shared/models/videos' | |
17 | import { readFile } from 'fs-extra' | |
18 | import { getActivityStreamDuration } from '../models/video/video-format-utils' | |
19 | import { AccountModel } from '../models/account/account' | |
20 | import { VideoChannelModel } from '../models/video/video-channel' | |
21 | import * as Bluebird from 'bluebird' | |
22 | import { CONFIG } from '../initializers/config' | |
23 | import { logger } from '../helpers/logger' | |
24 | import { MAccountActor, MChannelActor } from '../types/models' | |
25 | ||
26 | type Tags = { | |
27 | ogType: string | |
28 | twitterCard: string | |
29 | schemaType: string | |
30 | ||
31 | list?: { | |
32 | numberOfItems: number | |
33 | } | |
34 | ||
35 | title: string | |
36 | url: string | |
37 | description: string | |
38 | ||
39 | embed?: { | |
40 | url: string | |
41 | createdAt: string | |
42 | duration?: string | |
43 | views?: number | |
44 | } | |
45 | ||
46 | image: { | |
47 | url: string | |
48 | width?: number | |
49 | height?: number | |
50 | } | |
51 | } | |
52 | ||
53 | export class ClientHtml { | |
54 | ||
55 | private static htmlCache: { [path: string]: string } = {} | |
56 | ||
57 | static invalidCache () { | |
58 | logger.info('Cleaning HTML cache.') | |
59 | ||
60 | ClientHtml.htmlCache = {} | |
61 | } | |
62 | ||
63 | static async getDefaultHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { | |
64 | const html = paramLang | |
65 | ? await ClientHtml.getIndexHTML(req, res, paramLang) | |
66 | : await ClientHtml.getIndexHTML(req, res) | |
67 | ||
68 | let customHtml = ClientHtml.addTitleTag(html) | |
69 | customHtml = ClientHtml.addDescriptionTag(customHtml) | |
70 | ||
71 | return customHtml | |
72 | } | |
73 | ||
74 | static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) { | |
75 | // Let Angular application handle errors | |
76 | if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) { | |
77 | res.status(404) | |
78 | return ClientHtml.getIndexHTML(req, res) | |
79 | } | |
80 | ||
81 | const [ html, video ] = await Promise.all([ | |
82 | ClientHtml.getIndexHTML(req, res), | |
83 | VideoModel.loadWithBlacklist(videoId) | |
84 | ]) | |
85 | ||
86 | // Let Angular application handle errors | |
87 | if (!video || video.privacy === VideoPrivacy.PRIVATE || video.privacy === VideoPrivacy.INTERNAL || video.VideoBlacklist) { | |
88 | res.status(404) | |
89 | return html | |
90 | } | |
91 | ||
92 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) | |
93 | customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description)) | |
94 | ||
95 | const url = WEBSERVER.URL + video.getWatchStaticPath() | |
96 | const title = escapeHTML(video.name) | |
97 | const description = escapeHTML(video.description) | |
98 | ||
99 | const image = { | |
100 | url: WEBSERVER.URL + video.getPreviewStaticPath() | |
101 | } | |
102 | ||
103 | const embed = { | |
104 | url: WEBSERVER.URL + video.getEmbedStaticPath(), | |
105 | createdAt: video.createdAt.toISOString(), | |
106 | duration: getActivityStreamDuration(video.duration), | |
107 | views: video.views | |
108 | } | |
109 | ||
110 | const ogType = 'video' | |
111 | const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image' | |
112 | const schemaType = 'VideoObject' | |
113 | ||
114 | customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, embed, ogType, twitterCard, schemaType }) | |
115 | ||
116 | return customHtml | |
117 | } | |
118 | ||
119 | static async getWatchPlaylistHTMLPage (videoPlaylistId: string, req: express.Request, res: express.Response) { | |
120 | // Let Angular application handle errors | |
121 | if (!validator.isInt(videoPlaylistId) && !validator.isUUID(videoPlaylistId, 4)) { | |
122 | res.status(404) | |
123 | return ClientHtml.getIndexHTML(req, res) | |
124 | } | |
125 | ||
126 | const [ html, videoPlaylist ] = await Promise.all([ | |
127 | ClientHtml.getIndexHTML(req, res), | |
128 | VideoPlaylistModel.loadWithAccountAndChannel(videoPlaylistId, null) | |
129 | ]) | |
130 | ||
131 | // Let Angular application handle errors | |
132 | if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) { | |
133 | res.status(404) | |
134 | return html | |
135 | } | |
136 | ||
137 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(videoPlaylist.name)) | |
138 | customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(videoPlaylist.description)) | |
139 | ||
140 | const url = videoPlaylist.getWatchUrl() | |
141 | const title = escapeHTML(videoPlaylist.name) | |
142 | const description = escapeHTML(videoPlaylist.description) | |
143 | ||
144 | const image = { | |
145 | url: videoPlaylist.getThumbnailUrl() | |
146 | } | |
147 | ||
148 | const embed = { | |
149 | url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(), | |
150 | createdAt: videoPlaylist.createdAt.toISOString() | |
151 | } | |
152 | ||
153 | const list = { | |
154 | numberOfItems: videoPlaylist.get('videosLength') as number | |
155 | } | |
156 | ||
157 | const ogType = 'video' | |
158 | const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary' | |
159 | const schemaType = 'ItemList' | |
160 | ||
161 | customHtml = ClientHtml.addTags(customHtml, { url, embed, title, description, image, list, ogType, twitterCard, schemaType }) | |
162 | ||
163 | return customHtml | |
164 | } | |
165 | ||
166 | static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { | |
167 | return this.getAccountOrChannelHTMLPage(() => AccountModel.loadByNameWithHost(nameWithHost), req, res) | |
168 | } | |
169 | ||
170 | static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { | |
171 | return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res) | |
172 | } | |
173 | ||
174 | private static async getAccountOrChannelHTMLPage ( | |
175 | loader: () => Bluebird<MAccountActor | MChannelActor>, | |
176 | req: express.Request, | |
177 | res: express.Response | |
178 | ) { | |
179 | const [ html, entity ] = await Promise.all([ | |
180 | ClientHtml.getIndexHTML(req, res), | |
181 | loader() | |
182 | ]) | |
183 | ||
184 | // Let Angular application handle errors | |
185 | if (!entity) { | |
186 | res.status(404) | |
187 | return ClientHtml.getIndexHTML(req, res) | |
188 | } | |
189 | ||
190 | let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName())) | |
191 | customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(entity.description)) | |
192 | ||
193 | const url = entity.Actor.url | |
194 | const title = escapeHTML(entity.getDisplayName()) | |
195 | const description = escapeHTML(entity.description) | |
196 | ||
197 | const image = { | |
198 | url: entity.Actor.getAvatarUrl(), | |
199 | width: AVATARS_SIZE.width, | |
200 | height: AVATARS_SIZE.height | |
201 | } | |
202 | ||
203 | const ogType = 'website' | |
204 | const twitterCard = 'summary' | |
205 | const schemaType = 'ProfilePage' | |
206 | ||
207 | customHtml = ClientHtml.addTags(customHtml, { url, title, description, image, ogType, twitterCard, schemaType }) | |
208 | ||
209 | return customHtml | |
210 | } | |
211 | ||
212 | private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) { | |
213 | const path = ClientHtml.getIndexPath(req, res, paramLang) | |
214 | if (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path] | |
215 | ||
216 | const buffer = await readFile(path) | |
217 | ||
218 | let html = buffer.toString() | |
219 | ||
220 | if (paramLang) html = ClientHtml.addHtmlLang(html, paramLang) | |
221 | html = ClientHtml.addManifestContentHash(html) | |
222 | html = ClientHtml.addFaviconContentHash(html) | |
223 | html = ClientHtml.addLogoContentHash(html) | |
224 | html = ClientHtml.addCustomCSS(html) | |
225 | html = await ClientHtml.addAsyncPluginCSS(html) | |
226 | ||
227 | ClientHtml.htmlCache[path] = html | |
228 | ||
229 | return html | |
230 | } | |
231 | ||
232 | private static getIndexPath (req: express.Request, res: express.Response, paramLang: string) { | |
233 | let lang: string | |
234 | ||
235 | // Check param lang validity | |
236 | if (paramLang && is18nLocale(paramLang)) { | |
237 | lang = paramLang | |
238 | ||
239 | // Save locale in cookies | |
240 | res.cookie('clientLanguage', lang, { | |
241 | secure: WEBSERVER.SCHEME === 'https', | |
242 | sameSite: 'none', | |
243 | maxAge: 1000 * 3600 * 24 * 90 // 3 months | |
244 | }) | |
245 | ||
246 | } else if (req.cookies.clientLanguage && is18nLocale(req.cookies.clientLanguage)) { | |
247 | lang = req.cookies.clientLanguage | |
248 | } else { | |
249 | lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale() | |
250 | } | |
251 | ||
252 | return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html') | |
253 | } | |
254 | ||
255 | private static addHtmlLang (htmlStringPage: string, paramLang: string) { | |
256 | return htmlStringPage.replace('<html>', `<html lang="${paramLang}">`) | |
257 | } | |
258 | ||
259 | private static addManifestContentHash (htmlStringPage: string) { | |
260 | return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST) | |
261 | } | |
262 | ||
263 | private static addFaviconContentHash (htmlStringPage: string) { | |
264 | return htmlStringPage.replace('[faviconContentHash]', FILES_CONTENT_HASH.FAVICON) | |
265 | } | |
266 | ||
267 | private static addLogoContentHash (htmlStringPage: string) { | |
268 | return htmlStringPage.replace('[logoContentHash]', FILES_CONTENT_HASH.LOGO) | |
269 | } | |
270 | ||
271 | private static addTitleTag (htmlStringPage: string, title?: string) { | |
272 | let text = title || CONFIG.INSTANCE.NAME | |
273 | if (title) text += ` - ${CONFIG.INSTANCE.NAME}` | |
274 | ||
275 | const titleTag = `<title>${text}</title>` | |
276 | ||
277 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag) | |
278 | } | |
279 | ||
280 | private static addDescriptionTag (htmlStringPage: string, description?: string) { | |
281 | const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION | |
282 | const descriptionTag = `<meta name="description" content="${content}" />` | |
283 | ||
284 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag) | |
285 | } | |
286 | ||
287 | private static addCustomCSS (htmlStringPage: string) { | |
288 | const styleTag = `<style class="custom-css-style">${CONFIG.INSTANCE.CUSTOMIZATIONS.CSS}</style>` | |
289 | ||
290 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag) | |
291 | } | |
292 | ||
293 | private static async addAsyncPluginCSS (htmlStringPage: string) { | |
294 | const globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH) | |
295 | if (globalCSSContent.byteLength === 0) return htmlStringPage | |
296 | ||
297 | const fileHash = sha256(globalCSSContent) | |
298 | const linkTag = `<link rel="stylesheet" href="/plugins/global.css?hash=${fileHash}" />` | |
299 | ||
300 | return htmlStringPage.replace('</head>', linkTag + '</head>') | |
301 | } | |
302 | ||
303 | private static generateOpenGraphMetaTags (tags: Tags) { | |
304 | const metaTags = { | |
305 | 'og:type': tags.ogType, | |
306 | 'og:title': tags.title, | |
307 | 'og:image': tags.image.url | |
308 | } | |
309 | ||
310 | if (tags.image.width && tags.image.height) { | |
311 | metaTags['og:image:width'] = tags.image.width | |
312 | metaTags['og:image:height'] = tags.image.height | |
313 | } | |
314 | ||
315 | metaTags['og:url'] = tags.url | |
316 | metaTags['og:description'] = tags.description | |
317 | ||
318 | if (tags.embed) { | |
319 | metaTags['og:video:url'] = tags.embed.url | |
320 | metaTags['og:video:secure_url'] = tags.embed.url | |
321 | metaTags['og:video:type'] = 'text/html' | |
322 | metaTags['og:video:width'] = EMBED_SIZE.width | |
323 | metaTags['og:video:height'] = EMBED_SIZE.height | |
324 | } | |
325 | ||
326 | return metaTags | |
327 | } | |
328 | ||
329 | private static generateStandardMetaTags (tags: Tags) { | |
330 | return { | |
331 | name: tags.title, | |
332 | description: tags.description, | |
333 | image: tags.image.url | |
334 | } | |
335 | } | |
336 | ||
337 | private static generateTwitterCardMetaTags (tags: Tags) { | |
338 | const metaTags = { | |
339 | 'twitter:card': tags.twitterCard, | |
340 | 'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME, | |
341 | 'twitter:title': tags.title, | |
342 | 'twitter:description': tags.description, | |
343 | 'twitter:image': tags.image.url | |
344 | } | |
345 | ||
346 | if (tags.image.width && tags.image.height) { | |
347 | metaTags['twitter:image:width'] = tags.image.width | |
348 | metaTags['twitter:image:height'] = tags.image.height | |
349 | } | |
350 | ||
351 | return metaTags | |
352 | } | |
353 | ||
354 | private static generateSchemaTags (tags: Tags) { | |
355 | const schema = { | |
356 | '@context': 'http://schema.org', | |
357 | '@type': tags.schemaType, | |
358 | 'name': tags.title, | |
359 | 'description': tags.description, | |
360 | 'image': tags.image.url, | |
361 | 'url': tags.url | |
362 | } | |
363 | ||
364 | if (tags.list) { | |
365 | schema['numberOfItems'] = tags.list.numberOfItems | |
366 | schema['thumbnailUrl'] = tags.image.url | |
367 | } | |
368 | ||
369 | if (tags.embed) { | |
370 | schema['embedUrl'] = tags.embed.url | |
371 | schema['uploadDate'] = tags.embed.createdAt | |
372 | ||
373 | if (tags.embed.duration) schema['duration'] = tags.embed.duration | |
374 | if (tags.embed.views) schema['iterationCount'] = tags.embed.views | |
375 | ||
376 | schema['thumbnailUrl'] = tags.image.url | |
377 | schema['contentUrl'] = tags.url | |
378 | } | |
379 | ||
380 | return schema | |
381 | } | |
382 | ||
383 | private static addTags (htmlStringPage: string, tagsValues: Tags) { | |
384 | const openGraphMetaTags = this.generateOpenGraphMetaTags(tagsValues) | |
385 | const standardMetaTags = this.generateStandardMetaTags(tagsValues) | |
386 | const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues) | |
387 | const schemaTags = this.generateSchemaTags(tagsValues) | |
388 | ||
389 | const { url, title, embed } = tagsValues | |
390 | ||
391 | const oembedLinkTags: { type: string, href: string, title: string }[] = [] | |
392 | ||
393 | if (embed) { | |
394 | oembedLinkTags.push({ | |
395 | type: 'application/json+oembed', | |
396 | href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url), | |
397 | title | |
398 | }) | |
399 | } | |
400 | ||
401 | let tagsString = '' | |
402 | ||
403 | // Opengraph | |
404 | Object.keys(openGraphMetaTags).forEach(tagName => { | |
405 | const tagValue = openGraphMetaTags[tagName] | |
406 | ||
407 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
408 | }) | |
409 | ||
410 | // Standard | |
411 | Object.keys(standardMetaTags).forEach(tagName => { | |
412 | const tagValue = standardMetaTags[tagName] | |
413 | ||
414 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
415 | }) | |
416 | ||
417 | // Twitter card | |
418 | Object.keys(twitterCardMetaTags).forEach(tagName => { | |
419 | const tagValue = twitterCardMetaTags[tagName] | |
420 | ||
421 | tagsString += `<meta property="${tagName}" content="${tagValue}" />` | |
422 | }) | |
423 | ||
424 | // OEmbed | |
425 | for (const oembedLinkTag of oembedLinkTags) { | |
426 | tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />` | |
427 | } | |
428 | ||
429 | // Schema.org | |
430 | if (schemaTags) { | |
431 | tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>` | |
432 | } | |
433 | ||
434 | // SEO, use origin URL | |
435 | tagsString += `<link rel="canonical" href="${url}" />` | |
436 | ||
437 | return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsString) | |
438 | } | |
439 | } |