X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fclient.ts;h=a85c1072019d8ab01e5f519506f652500c544011;hb=6a4905602636afd6650c9e6f4d0fcc2105d91100;hp=08c0f1fa61b40958a01538086104abf30cfcdbed;hpb=bdd428a6d9138d751f8cde82867022a93f1a76cc;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/client.ts b/server/controllers/client.ts index 08c0f1fa6..a85c10720 100644 --- a/server/controllers/client.ts +++ b/server/controllers/client.ts @@ -1,55 +1,81 @@ -import * as express from 'express' +import express from 'express' +import { constants, promises as fs } from 'fs' +import { readFile } from 'fs-extra' import { join } from 'path' -import { root } from '../helpers/core-utils' -import { ACCEPT_HEADERS, STATIC_MAX_AGE } from '../initializers/constants' -import { asyncMiddleware, embedCSP } from '../middlewares' -import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '../../shared/models/i18n/i18n' -import { ClientHtml } from '../lib/client-html' -import { logger } from '../helpers/logger' +import { logger } from '@server/helpers/logger' import { CONFIG } from '@server/initializers/config' +import { Hooks } from '@server/lib/plugins/hooks' +import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n' +import { HttpStatusCode } from '@shared/models' +import { root } from '@shared/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 embedPath = join(distPath, 'standalone', 'videos', 'embed.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('/accounts/:nameWithHost', asyncMiddleware(generateAccountHtmlPage)) -clientsRouter.use('/video-channels/:nameWithHost', asyncMiddleware(generateVideoChannelHtmlPage)) - -const embedCSPMiddleware = CONFIG.CSP.ENABLED - ? embedCSP - : (req: express.Request, res: express.Response, next: express.NextFunction) => next() - -clientsRouter.use( - '/videos/embed', - embedCSPMiddleware, - (req: express.Request, res: express.Response) => { +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)) + +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') - res.sendFile(embedPath) - } -) -clientsRouter.use( - '/videos/test-embed', - (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath) -) - -// Static HTML/CSS/JS client files - -const staticClientFiles = [ - 'manifest.webmanifest', - 'ngsw-worker.js', - 'ngsw.json' + + // 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() + }, + + asyncMiddleware(generateEmbedHtmlPage) +] + +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', + 'assets/images/default-playlist.jpg', + 'assets/images/default-avatar-account.png', + 'assets/images/default-avatar-account-48x48.png', + 'assets/images/default-avatar-video-channel.png', + 'assets/images/default-avatar-video-channel-48x48.png' ] -for (const staticClientFile of staticClientFiles) { - const path = join(root(), 'client', 'dist', staticClientFile) - clientsRouter.get('/' + staticClientFile, (req: express.Request, res: express.Response) => { - res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) - }) +for (const staticClientOverride of staticClientOverrides) { + const overridePhysicalPath = join(CONFIG.STORAGE.CLIENT_OVERRIDES_DIR, staticClientOverride) + clientsRouter.use(`/client/${staticClientOverride}`, asyncMiddleware(serveClientOverride(overridePhysicalPath))) } clientsRouter.use('/client/locales/:locale/:file.json', serveServerTranslations) @@ -57,7 +83,7 @@ clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE.C // 404 for static files not found clientsRouter.use('/client/*', (req: express.Request, res: express.Response) => { - res.sendStatus(404) + res.status(HttpStatusCode.NOT_FOUND_404).end() }) // Always serve index client page (the client is a single page application, let it handle routing) @@ -84,48 +110,98 @@ function serveServerTranslations (req: express.Request, res: express.Response) { return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) } - return res.sendStatus(404) + return res.status(HttpStatusCode.NOT_FOUND_404).end() } -async function serveIndexHTML (req: express.Request, res: express.Response) { - if (req.accepts(ACCEPT_HEADERS) === 'html') { - try { - await generateHTMLPage(req, res, req.params.language) - return - } catch (err) { - logger.error('Cannot generate HTML page.', err) - } - } +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' - return res.status(404).end() -} + const allowParameters = { req } -async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { - const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang) + const allowedResult = await Hooks.wrapFun( + isEmbedAllowed, + allowParameters, + hookName + ) + + if (!allowedResult || allowedResult.allowed !== true) { + logger.info('Embed is not allowed.', { allowedResult }) + + return sendHTML(allowedResult?.html || '', res) + } + + const html = await ClientHtml.getEmbedHTML() return sendHTML(html, res) } async function generateWatchHtmlPage (req: express.Request, res: express.Response) { - const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res) + // Thread link is '/w/:videoId;threadId=:threadId' + // So to get the videoId we need to remove the last part + let videoId = req.params.id + '' - return sendHTML(html, res) + const threadIdIndex = videoId.indexOf(';threadId') + if (threadIdIndex !== -1) videoId = videoId.substring(0, threadIdIndex) + + const html = await ClientHtml.getWatchHTMLPage(videoId, req, res) + + return sendHTML(html, res, true) +} + +async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res) + + return sendHTML(html, res, true) } async function generateAccountHtmlPage (req: express.Request, res: express.Response) { const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res) - return sendHTML(html, res) + return sendHTML(html, res, true) } async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) { const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res) - return sendHTML(html, res) + return sendHTML(html, res, true) +} + +async function generateActorHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getActorHTMLPage(req.params.nameWithHost, req, res) + + return sendHTML(html, res, true) } -function sendHTML (html: string, res: express.Response) { - res.set('Content-Type', 'text/html; charset=UTF-8') +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) +} + +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() + } + } +} - return res.send(html) +type AllowedResult = { allowed: boolean, html?: string } +function isEmbedAllowed (_object: { + req: express.Request +}): AllowedResult { + return { allowed: true } }