X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fclient.ts;h=7a279d8d596aefdd0ce4aeacdc819a8315e63e44;hb=1d22d2514f7be14d51ed2ab78e13df5da2646546;hp=f51470b419507b64abde1c51b10346e8fc678c5f;hpb=97567dd81f508dd6295ac4d73d849aa2ce0a6549;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/client.ts b/server/controllers/client.ts index f51470b41..7a279d8d5 100644 --- a/server/controllers/client.ts +++ b/server/controllers/client.ts @@ -1,85 +1,85 @@ import * as express from 'express' +import { constants, promises as fs } from 'fs' +import { readFile } from 'fs-extra' import { join } from 'path' +import { CONFIG } from '@server/initializers/config' +import { HttpStatusCode } from '@shared/core-utils' +import { buildFileLocale, getCompleteLocale, I18N_LOCALES, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n' import { root } from '../helpers/core-utils' -import { ACCEPT_HEADERS, STATIC_MAX_AGE } from '../initializers/constants' +import { STATIC_MAX_AGE } from '../initializers/constants' +import { ClientHtml, sendHTML, serveIndexHTML } from '../lib/client-html' 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' 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 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/playlist/:id', asyncMiddleware(generateWatchPlaylistHtmlPage)) clientsRouter.use('/videos/watch/:id', asyncMiddleware(generateWatchHtmlPage)) clientsRouter.use('/accounts/:nameWithHost', asyncMiddleware(generateAccountHtmlPage)) clientsRouter.use('/video-channels/:nameWithHost', asyncMiddleware(generateVideoChannelHtmlPage)) -clientsRouter.use( - '/videos/embed', - embedCSP, - (req: express.Request, res: express.Response) => { +const embedMiddlewares = [ + CONFIG.CSP.ENABLED + ? embedCSP + : (req: express.Request, res: express.Response, next: express.NextFunction) => next(), + + (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' -] -for (const staticClientFile of staticClientFiles) { - const path = join(root(), 'client', 'dist', staticClientFile) - clientsRouter.use('/' + staticClientFile, express.static(path, { maxAge: STATIC_MAX_AGE })) -} -clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE })) -clientsRouter.use('/client/assets/images', express.static(assetsImagesPath, { maxAge: STATIC_MAX_AGE })) + // Don't cache HTML file since it's an index to the immutable JS/CSS files + res.setHeader('Cache-Control', 'public, max-age=0') -clientsRouter.use('/client/locales/:locale/:file.json', function (req, res) { - const locale = req.params.locale - const file = req.params.file + next() + }, - if (is18nLocale(locale) && LOCALE_FILES.indexOf(file) !== -1) { - const completeLocale = getCompleteLocale(locale) - const completeFileLocale = buildFileLocale(completeLocale) - return res.sendFile(join(__dirname, `../../../client/dist/locale/${file}_${completeFileLocale}.json`)) - } + asyncMiddleware(generateEmbedHtmlPage) +] - return res.sendStatus(404) -}) +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(/\/client\/[^/]+\/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 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) +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.sendStatus(HttpStatusCode.NOT_FOUND_404) }) // 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)?', async function (req, res) { - if (req.accepts(ACCEPT_HEADERS) === 'html') { - try { - await generateHTMLPage(req, res, req.params.language) - return - } catch (err) { - logger.error('Cannot generate HTML page.', err) - } - } - - return res.status(404).end() -}) +clientsRouter.use('/(:language)?', asyncMiddleware(serveIndexHTML)) // --------------------------------------------------------------------------- @@ -89,8 +89,23 @@ export { // --------------------------------------------------------------------------- -async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { - const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang) +function serveServerTranslations (req: express.Request, res: express.Response) { + const locale = req.params.locale + const file = req.params.file + + 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 }) + } + + return res.sendStatus(HttpStatusCode.NOT_FOUND_404) +} + +async function generateEmbedHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getEmbedHTML() return sendHTML(html, res) } @@ -101,6 +116,12 @@ async function generateWatchHtmlPage (req: express.Request, res: express.Respons return sendHTML(html, res) } +async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res) + + return sendHTML(html, res) +} + async function generateAccountHtmlPage (req: express.Request, res: express.Response) { const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res) @@ -113,8 +134,27 @@ async function generateVideoChannelHtmlPage (req: express.Request, res: express. return sendHTML(html, res) } -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 - return res.send(html) + 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() + } + } }