X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fclient.ts;h=335a0e082f2d6b570c6e026bd34ea911ba518672;hb=a5cf76afa378aae81af2a9b0ce548e5d2582f832;hp=f51470b419507b64abde1c51b10346e8fc678c5f;hpb=74dc3bca2b14f5fd3fe80c394dfc34177a46db77;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/client.ts b/server/controllers/client.ts index f51470b41..335a0e082 100644 --- a/server/controllers/client.ts +++ b/server/controllers/client.ts @@ -1,74 +1,122 @@ import * as express from 'express' +import { constants, promises as fs } from 'fs' import { join } from 'path' +import { CONFIG } from '@server/initializers/config' +import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n' import { root } from '../helpers/core-utils' +import { logger } from '../helpers/logger' 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 { 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 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 + // 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) + +// 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.get(`/${staticClientFile}`, (req: express.Request, res: express.Response) => { + res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) + }) } -clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE })) -clientsRouter.use('/client/assets/images', express.static(assetsImagesPath, { maxAge: STATIC_MAX_AGE })) +// Dynamic PWA manifest +clientsRouter.get('/manifest.webmanifest', asyncMiddleware(generateManifest)) + +// Static client overrides +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) => { + res.sendStatus(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)?', asyncMiddleware(serveIndexHTML)) + +// --------------------------------------------------------------------------- + +export { + clientsRouter +} -clientsRouter.use('/client/locales/:locale/:file.json', function (req, res) { +// --------------------------------------------------------------------------- + +function serveServerTranslations (req: express.Request, res: express.Response) { const locale = req.params.locale const file = req.params.file - if (is18nLocale(locale) && LOCALE_FILES.indexOf(file) !== -1) { + if (is18nLocale(locale) && LOCALE_FILES.includes(file)) { const completeLocale = getCompleteLocale(locale) const completeFileLocale = buildFileLocale(completeLocale) - return res.sendFile(join(__dirname, `../../../client/dist/locale/${file}_${completeFileLocale}.json`)) + + const path = join(__dirname, `../../../client/dist/locale/${file}.${completeFileLocale}.json`) + return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER }) } return res.sendStatus(404) -}) - -// 404 for static files not found -clientsRouter.use('/client/*', (req: express.Request, res: express.Response, next: express.NextFunction) => { - res.sendStatus(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) { +async function serveIndexHTML (req: express.Request, res: express.Response) { if (req.accepts(ACCEPT_HEADERS) === 'html') { try { await generateHTMLPage(req, res, req.params.language) @@ -79,16 +127,14 @@ clientsRouter.use('/(:language)?', async function (req, res) { } return res.status(404).end() -}) +} -// --------------------------------------------------------------------------- +async function generateEmbedHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getEmbedHTML() -export { - clientsRouter + return sendHTML(html, res) } -// --------------------------------------------------------------------------- - async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) { const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang) @@ -101,6 +147,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) @@ -118,3 +170,28 @@ function sendHTML (html: string, res: express.Response) { return res.send(html) } + +async function generateManifest (req: express.Request, res: express.Response) { + const manifestPhysicalPath = join(root(), 'client', 'dist', 'manifest.webmanifest') + const manifestJson = await fs.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() + } + } +}