server/controllers/client.ts

   1 import * as express from 'express'
   2 import { join } from 'path'
   3 import { root } from '../helpers/core-utils'
   4 import { ACCEPT_HEADERS, STATIC_MAX_AGE } from '../initializers/constants'
   5 import { asyncMiddleware, embedCSP } from '../middlewares'
   6 import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '../../shared/models/i18n/i18n'
   7 import { ClientHtml } from '../lib/client-html'
   8 import { logger } from '../helpers/logger'
   9
  10 const clientsRouter = express.Router()
  11
  12 const distPath = join(root(), 'client', 'dist')
  13 const assetsImagesPath = join(root(), 'client', 'dist', 'assets', 'images')
  14 const embedPath = join(distPath, 'standalone', 'videos', 'embed.html')
  15 const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html')
  16
  17 // Special route that add OpenGraph and oEmbed tags
  18 // Do not use a template engine for a so little thing
  19 clientsRouter.use('/videos/watch/:id', asyncMiddleware(generateWatchHtmlPage))
  20 clientsRouter.use('/accounts/:nameWithHost', asyncMiddleware(generateAccountHtmlPage))
  21 clientsRouter.use('/video-channels/:nameWithHost', asyncMiddleware(generateVideoChannelHtmlPage))
  22
  23 clientsRouter.use(
  24   '/videos/embed',
  25   embedCSP,
  26   (req: express.Request, res: express.Response) => {
  27     res.removeHeader('X-Frame-Options')
  28     res.sendFile(embedPath)
  29   }
  30 )
  31 clientsRouter.use(
  32   '/videos/test-embed',
  33   (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath)
  34 )
  35
  36 // Static HTML/CSS/JS client files
  37
  38 const staticClientFiles = [
  39   'manifest.webmanifest',
  40   'ngsw-worker.js',
  41   'ngsw.json'
  42 ]
  43 for (const staticClientFile of staticClientFiles) {
  44   const path = join(root(), 'client', 'dist', staticClientFile)
  45   clientsRouter.use('/' + staticClientFile, express.static(path, { maxAge: STATIC_MAX_AGE }))
  46 }
  47
  48 clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE }))
  49 clientsRouter.use('/client/assets/images', express.static(assetsImagesPath, { maxAge: STATIC_MAX_AGE }))
  50
  51 clientsRouter.use('/client/locales/:locale/:file.json', function (req, res) {
  52   const locale = req.params.locale
  53   const file = req.params.file
  54
  55   if (is18nLocale(locale) && LOCALE_FILES.indexOf(file) !== -1) {
  56     const completeLocale = getCompleteLocale(locale)
  57     const completeFileLocale = buildFileLocale(completeLocale)
  58     return res.sendFile(join(__dirname, `../../../client/dist/locale/${file}_${completeFileLocale}.json`))
  59   }
  60
  61   return res.sendStatus(404)
  62 })
  63
  64 // 404 for static files not found
  65 clientsRouter.use('/client/*', (req: express.Request, res: express.Response, next: express.NextFunction) => {
  66   res.sendStatus(404)
  67 })
  68
  69 // Always serve index client page (the client is a single page application, let it handle routing)
  70 // Try to provide the right language index.html
  71 clientsRouter.use('/(:language)?', async function (req, res) {
  72   if (req.accepts(ACCEPT_HEADERS) === 'html') {
  73     try {
  74       await generateHTMLPage(req, res, req.params.language)
  75       return
  76     } catch (err) {
  77       logger.error('Cannot generate HTML page.', err)
  78     }
  79   }
  80
  81   return res.status(404).end()
  82 })
  83
  84 // ---------------------------------------------------------------------------
  85
  86 export {
  87   clientsRouter
  88 }
  89
  90 // ---------------------------------------------------------------------------
  91
  92 async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
  93   const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
  94
  95   return sendHTML(html, res)
  96 }
  97
  98 async function generateWatchHtmlPage (req: express.Request, res: express.Response) {
  99   const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res)
 100
 101   return sendHTML(html, res)
 102 }
 103
 104 async function generateAccountHtmlPage (req: express.Request, res: express.Response) {
 105   const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res)
 106
 107   return sendHTML(html, res)
 108 }
 109
 110 async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) {
 111   const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res)
 112
 113   return sendHTML(html, res)
 114 }
 115
 116 function sendHTML (html: string, res: express.Response) {
 117   res.set('Content-Type', 'text/html; charset=UTF-8')
 118
 119   return res.send(html)
 120 }