]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/client.ts
add client overrides to nginx configuration (#3297)
[github/Chocobozzz/PeerTube.git] / server / controllers / client.ts
index f474c4282006c65ed0b8e2f772b56cfb5518e2ed..592233676a7b0460a7da3977f2c25f0c5ff52c36 100644 (file)
@@ -1,46 +1,99 @@
 import * as express from 'express'
+import { constants, promises as fs } from 'fs'
 import { join } from 'path'
-import * as validator from 'validator'
-import * as Bluebird from 'bluebird'
-
-import { database as db } from '../initializers/database'
-import {
-  CONFIG,
-  STATIC_PATHS,
-  STATIC_MAX_AGE,
-  OPENGRAPH_AND_OEMBED_COMMENT,
-  EMBED_SIZE
-} from '../initializers'
-import { root, readFileBufferPromise, escapeHTML } from '../helpers'
-import { asyncMiddleware } from '../middlewares'
-import { VideoInstance } from '../models'
+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 { ClientHtml } from '../lib/client-html'
+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 indexPath = join(distPath, 'index.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('/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', (req: express.Request, res: express.Response, next: express.NextFunction) => {
-  res.sendFile(embedPath)
-})
+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')
+
+    // 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
-clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE }))
-clientsRouter.use('/client/assets/images', express.static(assetsImagesPath, { maxAge: STATIC_MAX_AGE }))
+const staticClientFiles = [
+  'ngsw-worker.js',
+  'ngsw.json'
+]
+
+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 })
+  })
+}
+
+// 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'
+]
+
+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) => {
+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 {
@@ -49,86 +102,97 @@ export {
 
 // ---------------------------------------------------------------------------
 
-function addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoInstance) {
-  const previewUrl = CONFIG.WEBSERVER.URL + STATIC_PATHS.PREVIEWS + video.getPreviewName()
-  const videoUrl = CONFIG.WEBSERVER.URL + '/videos/watch/' + video.uuid
-
-  const videoNameEscaped = escapeHTML(video.name)
-  const videoDescriptionEscaped = escapeHTML(video.description)
-  const embedUrl = CONFIG.WEBSERVER.URL + video.getEmbedPath()
-
-  const openGraphMetaTags = {
-    'og:type': 'video',
-    'og:title': videoNameEscaped,
-    'og:image': previewUrl,
-    'og:url': videoUrl,
-    'og:description': videoDescriptionEscaped,
-
-    'og:video:url': embedUrl,
-    'og:video:secure_url': embedUrl,
-    'og:video:type': 'text/html',
-    'og:video:width': EMBED_SIZE.width,
-    'og:video:height': EMBED_SIZE.height,
-
-    'name': videoNameEscaped,
-    'description': videoDescriptionEscaped,
-    'image': previewUrl,
-
-    'twitter:card': 'summary_large_image',
-    'twitter:site': '@Chocobozzz',
-    'twitter:title': videoNameEscaped,
-    'twitter:description': videoDescriptionEscaped,
-    'twitter:image': previewUrl,
-    'twitter:player': embedUrl,
-    'twitter:player:width': EMBED_SIZE.width,
-    'twitter:player:height': EMBED_SIZE.height
+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 })
   }
 
-  const oembedLinkTags = [
-    {
-      type: 'application/json+oembed',
-      href: CONFIG.WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl),
-      title: videoNameEscaped
+  return res.sendStatus(404)
+}
+
+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)
     }
-  ]
+  }
+
+  return res.status(404).end()
+}
 
-  let tagsString = ''
-  Object.keys(openGraphMetaTags).forEach(tagName => {
-    const tagValue = openGraphMetaTags[tagName]
+async function generateEmbedHtmlPage (req: express.Request, res: express.Response) {
+  const html = await ClientHtml.getEmbedHTML()
 
-    tagsString += `<meta property="${tagName}" content="${tagValue}" />`
-  })
+  return sendHTML(html, res)
+}
 
-  for (const oembedLinkTag of oembedLinkTags) {
-    tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
-  }
+async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
+  const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
 
-  return htmlStringPage.replace(OPENGRAPH_AND_OEMBED_COMMENT, tagsString)
+  return sendHTML(html, res)
 }
 
-async function generateWatchHtmlPage (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const videoId = '' + req.params.id
-  let videoPromise: Bluebird<VideoInstance>
-
-  // Let Angular application handle errors
-  if (validator.isUUID(videoId, 4)) {
-    videoPromise = db.Video.loadByUUIDAndPopulateAccountAndServerAndTags(videoId)
-  } else if (validator.isInt(videoId)) {
-    videoPromise = db.Video.loadAndPopulateAccountAndServerAndTags(+videoId)
-  } else {
-    return res.sendFile(indexPath)
-  }
+async function generateWatchHtmlPage (req: express.Request, res: express.Response) {
+  const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res)
+
+  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)
 
-  let [ file, video ] = await Promise.all([
-    readFileBufferPromise(indexPath),
-    videoPromise
-  ])
+  return sendHTML(html, res)
+}
+
+async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) {
+  const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res)
+
+  return sendHTML(html, res)
+}
+
+function sendHTML (html: string, res: express.Response) {
+  res.set('Content-Type', 'text/html; charset=UTF-8')
 
-  const html = file.toString()
+  return res.send(html)
+}
 
-  // Let Angular application handle errors
-  if (!video) return res.sendFile(indexPath)
+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)
 
-  const htmlStringPageWithTags = addOpenGraphAndOEmbedTags(html, video)
-  res.set('Content-Type', 'text/html; charset=UTF-8').send(htmlStringPageWithTags)
+  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()
+    }
+  }
 }