X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fclient.ts;h=eb1ee6cbd6e8e6e546cbb118003a9599ea071dc6;hb=76148b27f7501bac061992136852be4303370c8d;hp=20f7e5c9c2a613abee62adb73310615c11f991b5;hpb=8be1afa12b700b93ed92365cab05c0ef81d643aa;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/client.ts b/server/controllers/client.ts index 20f7e5c9c..eb1ee6cbd 100644 --- a/server/controllers/client.ts +++ b/server/controllers/client.ts @@ -1,49 +1,90 @@ -import * as Bluebird from 'bluebird' import * as express from 'express' +import { constants, promises as fs } from 'fs' +import { readFile } from 'fs-extra' import { join } from 'path' -import * as validator from 'validator' -import { escapeHTML, readFileBufferPromise, root } from '../helpers/core-utils' -import { CONFIG, EMBED_SIZE, OPENGRAPH_AND_OEMBED_COMMENT, STATIC_MAX_AGE, STATIC_PATHS } from '../initializers' -import { asyncMiddleware } from '../middlewares' -import { VideoModel } from '../models/video/video' +import { logger } from '@server/helpers/logger' +import { CONFIG } from '@server/initializers/config' +import { Hooks } from '@server/lib/plugins/hooks' +import { HttpStatusCode } from '@shared/core-utils' +import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n' +import { root } from '../helpers/core-utils' +import { STATIC_MAX_AGE } from '../initializers/constants' +import { ClientHtml, sendHTML, serveIndexHTML } from '../lib/client-html' +import { asyncMiddleware, embedCSP } from '../middlewares' const clientsRouter = express.Router() const distPath = join(root(), 'client', 'dist') -const assetsImagesPath = join(root(), 'client', 'dist', 'assets', 'images') -const embedPath = join(distPath, 'standalone', 'videos', 'embed.html') -const indexPath = join(distPath, 'index.html') +const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html') // Special route that add OpenGraph and oEmbed tags // Do not use a template engine for a so little thing -clientsRouter.use('/videos/watch/:id', - asyncMiddleware(generateWatchHtmlPage) -) +clientsRouter.use([ '/w/p/:id', '/videos/watch/playlist/:id' ], asyncMiddleware(generateWatchPlaylistHtmlPage)) +clientsRouter.use([ '/w/:id', '/videos/watch/:id' ], asyncMiddleware(generateWatchHtmlPage)) +clientsRouter.use([ '/accounts/:nameWithHost', '/a/:nameWithHost' ], asyncMiddleware(generateAccountHtmlPage)) +clientsRouter.use([ '/video-channels/:nameWithHost', '/c/:nameWithHost' ], asyncMiddleware(generateVideoChannelHtmlPage)) +clientsRouter.use('/@:nameWithHost', asyncMiddleware(generateActorHtmlPage)) -clientsRouter.use('/videos/embed', (req: express.Request, res: express.Response, next: express.NextFunction) => { - res.sendFile(embedPath) -}) +const embedMiddlewares = [ + CONFIG.CSP.ENABLED + ? embedCSP + : (req: express.Request, res: express.Response, next: express.NextFunction) => next(), + + // Set headers + (req: express.Request, res: express.Response, next: express.NextFunction) => { + res.removeHeader('X-Frame-Options') + + // Don't cache HTML file since it's an index to the immutable JS/CSS files + res.setHeader('Cache-Control', 'public, max-age=0') + + next() + }, -// Static HTML/CSS/JS client files + asyncMiddleware(generateEmbedHtmlPage) +] -const staticClientFiles = [ - 'manifest.json', - 'ngsw-worker.js', - 'ngsw.json' +clientsRouter.use('/videos/embed', ...embedMiddlewares) +clientsRouter.use('/video-playlists/embed', ...embedMiddlewares) + +const testEmbedController = (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath) + +clientsRouter.use('/videos/test-embed', testEmbedController) +clientsRouter.use('/video-playlists/test-embed', testEmbedController) + +// Dynamic PWA manifest +clientsRouter.get('/manifest.webmanifest', asyncMiddleware(generateManifest)) + +// Static client overrides +// Must be consistent with static client overrides redirections in /support/nginx/peertube +const staticClientOverrides = [ + 'assets/images/logo.svg', + 'assets/images/favicon.png', + 'assets/images/icons/icon-36x36.png', + 'assets/images/icons/icon-48x48.png', + 'assets/images/icons/icon-72x72.png', + 'assets/images/icons/icon-96x96.png', + 'assets/images/icons/icon-144x144.png', + 'assets/images/icons/icon-192x192.png', + 'assets/images/icons/icon-512x512.png' ] -for (const staticClientFile of staticClientFiles) { - const path = join(root(), 'client', 'dist', staticClientFile) - clientsRouter.use('/' + staticClientFile, express.static(path, { maxAge: STATIC_MAX_AGE })) + +for (const staticClientOverride of staticClientOverrides) { + const overridePhysicalPath = join(CONFIG.STORAGE.CLIENT_OVERRIDES_DIR, staticClientOverride) + clientsRouter.use(`/client/${staticClientOverride}`, asyncMiddleware(serveClientOverride(overridePhysicalPath))) } -clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE })) -clientsRouter.use('/client/assets/images', express.static(assetsImagesPath, { maxAge: STATIC_MAX_AGE })) +clientsRouter.use('/client/locales/:locale/:file.json', serveServerTranslations) +clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE.CLIENT })) // 404 for static files not found -clientsRouter.use('/client/*', (req: express.Request, res: express.Response, next: express.NextFunction) => { - res.sendStatus(404) +clientsRouter.use('/client/*', (req: express.Request, res: express.Response) => { + res.status(HttpStatusCode.NOT_FOUND_404).end() }) +// Always serve index client page (the client is a single page application, let it handle routing) +// Try to provide the right language index.html +clientsRouter.use('/(:language)?', asyncMiddleware(serveIndexHTML)) + // --------------------------------------------------------------------------- export { @@ -52,108 +93,103 @@ export { // --------------------------------------------------------------------------- -function addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) { - const previewUrl = CONFIG.WEBSERVER.URL + STATIC_PATHS.PREVIEWS + video.getPreviewName() - const videoUrl = CONFIG.WEBSERVER.URL + '/videos/watch/' + video.uuid - - const videoNameEscaped = escapeHTML(video.name) - const videoDescriptionEscaped = escapeHTML(video.description) - const embedUrl = CONFIG.WEBSERVER.URL + video.getEmbedPath() - - const openGraphMetaTags = { - 'og:type': 'video', - 'og:title': videoNameEscaped, - 'og:image': previewUrl, - 'og:url': videoUrl, - 'og:description': videoDescriptionEscaped, - - '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, - - 'name': videoNameEscaped, - 'description': videoDescriptionEscaped, - 'image': previewUrl, - - 'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image', - '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 - } +function serveServerTranslations (req: express.Request, res: express.Response) { + const locale = req.params.locale + const file = req.params.file - const oembedLinkTags = [ - { - type: 'application/json+oembed', - href: CONFIG.WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl), - title: videoNameEscaped - } - ] - - const schemaTags = { - '@context': 'http://schema.org', - '@type': 'VideoObject', - name: videoNameEscaped, - description: videoDescriptionEscaped, - thumbnailUrl: previewUrl, - uploadDate: video.createdAt.toISOString(), - duration: video.getActivityStreamDuration(), - contentUrl: videoUrl, - embedUrl: embedUrl, - interactionCount: video.views + if (is18nLocale(locale) && LOCALE_FILES.includes(file)) { + const completeLocale = getCompleteLocale(locale) + const completeFileLocale = buildFileLocale(completeLocale) + + const path = join(__dirname, `../../../client/dist/locale/${file}.${completeFileLocale}.json`) + return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) } - let tagsString = '' + return res.status(HttpStatusCode.NOT_FOUND_404).end() +} + +async function generateEmbedHtmlPage (req: express.Request, res: express.Response) { + const hookName = req.originalUrl.startsWith('/video-playlists/') + ? 'filter:html.embed.video-playlist.allowed.result' + : 'filter:html.embed.video.allowed.result' - // Opengraph - Object.keys(openGraphMetaTags).forEach(tagName => { - const tagValue = openGraphMetaTags[tagName] + const allowParameters = { req } - tagsString += `` - }) + const allowedResult = await Hooks.wrapFun( + isEmbedAllowed, + allowParameters, + hookName + ) - // OEmbed - for (const oembedLinkTag of oembedLinkTags) { - tagsString += `` + if (!allowedResult || allowedResult.allowed !== true) { + logger.info('Embed is not allowed.', { allowedResult }) + + return sendHTML(allowedResult?.html || '', res) } - // Schema.org - tagsString += `` + const html = await ClientHtml.getEmbedHTML() + + return sendHTML(html, res) +} - // SEO - tagsString += `` +async function generateWatchHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res) - return htmlStringPage.replace(OPENGRAPH_AND_OEMBED_COMMENT, tagsString) + return sendHTML(html, res) } -async function generateWatchHtmlPage (req: express.Request, res: express.Response, next: express.NextFunction) { - const videoId = '' + req.params.id - let videoPromise: Bluebird - - // Let Angular application handle errors - if (validator.isUUID(videoId, 4)) { - videoPromise = VideoModel.loadByUUIDAndPopulateAccountAndServerAndTags(videoId) - } else if (validator.isInt(videoId)) { - videoPromise = VideoModel.loadAndPopulateAccountAndServerAndTags(+videoId) - } else { - return res.sendFile(indexPath) - } +async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res) - let [ file, video ] = await Promise.all([ - readFileBufferPromise(indexPath), - videoPromise - ]) + return sendHTML(html, res) +} + +async function generateAccountHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res) + + return sendHTML(html, res) +} + +async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res) + + return sendHTML(html, res) +} + +async function generateActorHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getActorHTMLPage(req.params.nameWithHost, req, res) - const html = file.toString() + return sendHTML(html, res) +} + +async function generateManifest (req: express.Request, res: express.Response) { + const manifestPhysicalPath = join(root(), 'client', 'dist', 'manifest.webmanifest') + const manifestJson = await readFile(manifestPhysicalPath, 'utf8') + const manifest = JSON.parse(manifestJson) + + manifest.name = CONFIG.INSTANCE.NAME + manifest.short_name = CONFIG.INSTANCE.NAME + manifest.description = CONFIG.INSTANCE.SHORT_DESCRIPTION + + res.json(manifest) +} - // Let Angular application handle errors - if (!video) return res.sendFile(indexPath) +function serveClientOverride (path: string) { + return async (req: express.Request, res: express.Response, next: express.NextFunction) => { + try { + await fs.access(path, constants.F_OK) + // Serve override client + res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) + } catch { + // Serve dist client + next() + } + } +} - const htmlStringPageWithTags = addOpenGraphAndOEmbedTags(html, video) - res.set('Content-Type', 'text/html; charset=UTF-8').send(htmlStringPageWithTags) +type AllowedResult = { allowed: boolean, html?: string } +function isEmbedAllowed (_object: { + req: express.Request +}): AllowedResult { + return { allowed: true } }