server/controllers/client.ts

   1 import * as express from 'express'
   2 import { constants, promises as fs } from 'fs'
   3 import { join } from 'path'
   4 import { CONFIG } from '@server/initializers/config'
   5 import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@shared/core-utils/i18n'
   6 import { root } from '../helpers/core-utils'
   7 import { logger } from '../helpers/logger'
   8 import { ACCEPT_HEADERS, STATIC_MAX_AGE } from '../initializers/constants'
   9 import { ClientHtml } from '../lib/client-html'
  10 import { asyncMiddleware, embedCSP } from '../middlewares'
  11
  12 const clientsRouter = express.Router()
  13
  14 const distPath = join(root(), 'client', 'dist')
  15 const embedPath = join(distPath, 'standalone', 'videos', 'embed.html')
  16 const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html')
  17
  18 // Special route that add OpenGraph and oEmbed tags
  19 // Do not use a template engine for a so little thing
  20 clientsRouter.use('/videos/watch/playlist/:id', asyncMiddleware(generateWatchPlaylistHtmlPage))
  21 clientsRouter.use('/videos/watch/:id', asyncMiddleware(generateWatchHtmlPage))
  22 clientsRouter.use('/accounts/:nameWithHost', asyncMiddleware(generateAccountHtmlPage))
  23 clientsRouter.use('/video-channels/:nameWithHost', asyncMiddleware(generateVideoChannelHtmlPage))
  24
  25 const embedMiddlewares = [
  26   CONFIG.CSP.ENABLED
  27     ? embedCSP
  28     : (req: express.Request, res: express.Response, next: express.NextFunction) => next(),
  29
  30   (req: express.Request, res: express.Response) => {
  31     res.removeHeader('X-Frame-Options')
  32     // Don't cache HTML file since it's an index to the immutable JS/CSS files
  33     res.sendFile(embedPath, { maxAge: 0 })
  34   }
  35 ]
  36
  37 clientsRouter.use('/videos/embed', ...embedMiddlewares)
  38 clientsRouter.use('/video-playlists/embed', ...embedMiddlewares)
  39
  40 const testEmbedController = (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath)
  41
  42 clientsRouter.use('/videos/test-embed', testEmbedController)
  43 clientsRouter.use('/video-playlists/test-embed', testEmbedController)
  44
  45 // Static HTML/CSS/JS client files
  46 const staticClientFiles = [
  47   'ngsw-worker.js',
  48   'ngsw.json'
  49 ]
  50
  51 for (const staticClientFile of staticClientFiles) {
  52   const path = join(root(), 'client', 'dist', staticClientFile)
  53
  54   clientsRouter.get(`/${staticClientFile}`, (req: express.Request, res: express.Response) => {
  55     res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER })
  56   })
  57 }
  58
  59 // Dynamic PWA manifest
  60 clientsRouter.get('/manifest.webmanifest', asyncMiddleware(generateManifest))
  61
  62 // Static client overrides
  63 const staticClientOverrides = [
  64   'assets/images/logo.svg',
  65   'assets/images/favicon.png',
  66   'assets/images/icons/icon-36x36.png',
  67   'assets/images/icons/icon-48x48.png',
  68   'assets/images/icons/icon-72x72.png',
  69   'assets/images/icons/icon-96x96.png',
  70   'assets/images/icons/icon-144x144.png',
  71   'assets/images/icons/icon-192x192.png',
  72   'assets/images/icons/icon-512x512.png'
  73 ]
  74
  75 for (const staticClientOverride of staticClientOverrides) {
  76   const overridePhysicalPath = join(CONFIG.STORAGE.CLIENT_OVERRIDES_DIR, staticClientOverride)
  77   clientsRouter.use(`/client/${staticClientOverride}`, asyncMiddleware(serveClientOverride(overridePhysicalPath)))
  78 }
  79
  80 clientsRouter.use('/client/locales/:locale/:file.json', serveServerTranslations)
  81 clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE.CLIENT }))
  82
  83 // 404 for static files not found
  84 clientsRouter.use('/client/*', (req: express.Request, res: express.Response) => {
  85   res.sendStatus(404)
  86 })
  87
  88 // Always serve index client page (the client is a single page application, let it handle routing)
  89 // Try to provide the right language index.html
  90 clientsRouter.use('/(:language)?', asyncMiddleware(serveIndexHTML))
  91
  92 // ---------------------------------------------------------------------------
  93
  94 export {
  95   clientsRouter
  96 }
  97
  98 // ---------------------------------------------------------------------------
  99
 100 function serveServerTranslations (req: express.Request, res: express.Response) {
 101   const locale = req.params.locale
 102   const file = req.params.file
 103
 104   if (is18nLocale(locale) && LOCALE_FILES.includes(file)) {
 105     const completeLocale = getCompleteLocale(locale)
 106     const completeFileLocale = buildFileLocale(completeLocale)
 107
 108     const path = join(__dirname, `../../../client/dist/locale/${file}.${completeFileLocale}.json`)
 109     return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER })
 110   }
 111
 112   return res.sendStatus(404)
 113 }
 114
 115 async function serveIndexHTML (req: express.Request, res: express.Response) {
 116   if (req.accepts(ACCEPT_HEADERS) === 'html') {
 117     try {
 118       await generateHTMLPage(req, res, req.params.language)
 119       return
 120     } catch (err) {
 121       logger.error('Cannot generate HTML page.', err)
 122     }
 123   }
 124
 125   return res.status(404).end()
 126 }
 127
 128 async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
 129   const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
 130
 131   return sendHTML(html, res)
 132 }
 133
 134 async function generateWatchHtmlPage (req: express.Request, res: express.Response) {
 135   const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res)
 136
 137   return sendHTML(html, res)
 138 }
 139
 140 async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) {
 141   const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res)
 142
 143   return sendHTML(html, res)
 144 }
 145
 146 async function generateAccountHtmlPage (req: express.Request, res: express.Response) {
 147   const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res)
 148
 149   return sendHTML(html, res)
 150 }
 151
 152 async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) {
 153   const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res)
 154
 155   return sendHTML(html, res)
 156 }
 157
 158 function sendHTML (html: string, res: express.Response) {
 159   res.set('Content-Type', 'text/html; charset=UTF-8')
 160
 161   return res.send(html)
 162 }
 163
 164 async function generateManifest (req: express.Request, res: express.Response) {
 165   const manifestPhysicalPath = join(root(), 'client', 'dist', 'manifest.webmanifest')
 166   const manifestJson = await fs.readFile(manifestPhysicalPath, 'utf8')
 167   const manifest = JSON.parse(manifestJson)
 168
 169   manifest.name = CONFIG.INSTANCE.NAME
 170   manifest.short_name = CONFIG.INSTANCE.NAME
 171   manifest.description = CONFIG.INSTANCE.SHORT_DESCRIPTION
 172
 173   res.json(manifest)
 174 }
 175
 176 function serveClientOverride (path: string) {
 177   return async (req: express.Request, res: express.Response, next: express.NextFunction) => {
 178     try {
 179       await fs.access(path, constants.F_OK)
 180       // Serve override client
 181       res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER })
 182     } catch {
 183       // Serve dist client
 184       next()
 185     }
 186   }
 187 }