]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/client.ts
Add server localization
[github/Chocobozzz/PeerTube.git] / server / controllers / client.ts
index c3d28245c329bfc5d180d0073a21389abc893b1a..ec78a4bbc0cbcf25e1376d3fd8038ffafff81f1d 100644 (file)
@@ -1,42 +1,78 @@
-import { parallel } from 'async'
+import * as Bluebird from 'bluebird'
 import * as express from 'express'
-import * as fs from 'fs'
 import { join } from 'path'
 import * as validator from 'validator'
-
-import { database as db } from '../initializers/database'
+import { escapeHTML, readFileBufferPromise, root } from '../helpers/core-utils'
 import {
+  ACCEPT_HEADERS,
   CONFIG,
-  REMOTE_SCHEME,
-  STATIC_PATHS,
-  STATIC_MAX_AGE
+  EMBED_SIZE,
+  OPENGRAPH_AND_OEMBED_COMMENT,
+  STATIC_MAX_AGE,
+  STATIC_PATHS
 } from '../initializers'
-import { root } from '../helpers'
+import { asyncMiddleware } from '../middlewares'
+import { VideoModel } from '../models/video/video'
+import { VideoPrivacy } from '../../shared/models/videos'
+import { I18N_LOCALES, is18nLocale, getDefaultLocale } from '../../shared/models'
 
 const clientsRouter = express.Router()
 
-// TODO: move to constants
-const opengraphComment = '<!-- opengraph tags -->'
 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')
 
-// Special route that add OpenGraph tags
+// Special route that add OpenGraph and oEmbed tags
 // Do not use a template engine for a so little thing
-clientsRouter.use('/videos/watch/:id', generateWatchHtmlPage)
+clientsRouter.use('/videos/watch/:id',
+  asyncMiddleware(generateWatchHtmlPage)
+)
 
-clientsRouter.use('/videos/embed', function (req, res, next) {
+clientsRouter.use('/videos/embed', (req: express.Request, res: express.Response, next: express.NextFunction) => {
   res.sendFile(embedPath)
 })
 
 // Static HTML/CSS/JS client files
+
+const staticClientFiles = [
+  'manifest.json',
+  '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 }))
+
+clientsRouter.use('/client/locales/:locale/:file.json', function (req, res) {
+  const locale = req.params.locale
+  const file = req.params.file
+
+  if (is18nLocale(locale) && [ 'player', 'server' ].indexOf(file) !== -1) {
+    return res.sendFile(join(__dirname, `../../../client/dist/locale/${file}_${locale}.json`))
+  }
+
+  return res.sendStatus(404)
+})
 
 // 404 for static files not found
-clientsRouter.use('/client/*', function (req, res, next) {
+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)?', function (req, res) {
+  if (req.accepts(ACCEPT_HEADERS) === 'html') {
+    return res.sendFile(getIndexPath(req, req.params.language))
+  }
+
+  return res.status(404).end()
+})
+
 // ---------------------------------------------------------------------------
 
 export {
@@ -45,73 +81,123 @@ export {
 
 // ---------------------------------------------------------------------------
 
-function addOpenGraphTags (htmlStringPage, video) {
-  let basePreviewUrlHttp
+function getIndexPath (req: express.Request, paramLang?: string) {
+  let lang: string
 
-  if (video.isOwned()) {
-    basePreviewUrlHttp = CONFIG.WEBSERVER.URL
+  // Check param lang validity
+  if (paramLang && is18nLocale(paramLang)) {
+    lang = paramLang
   } else {
-    basePreviewUrlHttp = REMOTE_SCHEME.HTTP + '://' + video.Author.Pod.host
+    // lang = req.acceptsLanguages(Object.keys(I18N_LOCALES)) || getDefaultLocale()
+    // Disable auto language for now
+    lang = getDefaultLocale()
   }
 
-  // We fetch the remote preview (bigger than the thumbnail)
-  // This should not overhead the remote server since social websites put in a cache the OpenGraph tags
-  // We can't use the thumbnail because these social websites want bigger images (> 200x200 for Facebook for example)
-  const previewUrl = basePreviewUrlHttp + STATIC_PATHS.PREVIEWS + video.getPreviewName()
-  const videoUrl = CONFIG.WEBSERVER.URL + '/videos/watch/' + video.id
+  return join(__dirname, '../../../client/dist/' + lang + '/index.html')
+}
+
+function addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) {
+  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 metaTags = {
+  const openGraphMetaTags = {
     'og:type': 'video',
-    'og:title': video.name,
+    'og:title': videoNameEscaped,
     'og:image': previewUrl,
     'og:url': videoUrl,
-    'og:description': video.description,
+    'og:description': videoDescriptionEscaped,
 
-    'name': video.name,
-    'description': video.description,
+    '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': video.name,
-    'twitter:description': video.description,
-    'twitter:image': previewUrl
+    'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image',
+    'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
+    'twitter:title': videoNameEscaped,
+    'twitter:description': videoDescriptionEscaped,
+    'twitter:image': previewUrl,
+    'twitter:player': embedUrl,
+    'twitter:player:width': EMBED_SIZE.width,
+    'twitter:player:height': EMBED_SIZE.height
+  }
+
+  const oembedLinkTags = [
+    {
+      type: 'application/json+oembed',
+      href: CONFIG.WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl),
+      title: videoNameEscaped
+    }
+  ]
+
+  const schemaTags = {
+    '@context': 'http://schema.org',
+    '@type': 'VideoObject',
+    name: videoNameEscaped,
+    description: videoDescriptionEscaped,
+    thumbnailUrl: previewUrl,
+    uploadDate: video.createdAt.toISOString(),
+    duration: video.getActivityStreamDuration(),
+    contentUrl: videoUrl,
+    embedUrl: embedUrl,
+    interactionCount: video.views
   }
 
   let tagsString = ''
-  Object.keys(metaTags).forEach(function (tagName) {
-    const tagValue = metaTags[tagName]
 
-    tagsString += '<meta property="' + tagName + '" content="' + tagValue + '" />'
+  // Opengraph
+  Object.keys(openGraphMetaTags).forEach(tagName => {
+    const tagValue = openGraphMetaTags[tagName]
+
+    tagsString += `<meta property="${tagName}" content="${tagValue}" />`
   })
 
-  return htmlStringPage.replace(opengraphComment, tagsString)
+  // OEmbed
+  for (const oembedLinkTag of oembedLinkTags) {
+    tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
+  }
+
+  // Schema.org
+  tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
+
+  // SEO
+  tagsString += `<link rel="canonical" href="${videoUrl}" />`
+
+  return htmlStringPage.replace(OPENGRAPH_AND_OEMBED_COMMENT, tagsString)
 }
 
-function generateWatchHtmlPage (req, res, next) {
-  const videoId = req.params.id
+async function generateWatchHtmlPage (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const videoId = '' + req.params.id
+  let videoPromise: Bluebird<VideoModel>
 
   // Let Angular application handle errors
-  if (!validator.isUUID(videoId, 4)) return res.sendFile(indexPath)
+  if (validator.isUUID(videoId, 4)) {
+    videoPromise = VideoModel.loadByUUIDAndPopulateAccountAndServerAndTags(videoId)
+  } else if (validator.isInt(videoId)) {
+    videoPromise = VideoModel.loadAndPopulateAccountAndServerAndTags(+videoId)
+  } else {
+    return res.sendFile(getIndexPath(req))
+  }
 
-  parallel({
-    file: function (callback) {
-      fs.readFile(indexPath, callback)
-    },
+  let [ file, video ] = await Promise.all([
+    readFileBufferPromise(getIndexPath(req)),
+    videoPromise
+  ])
 
-    video: function (callback) {
-      db.Video.loadAndPopulateAuthorAndPodAndTags(videoId, callback)
-    }
-  }, function (err, result: any) {
-    if (err) return next(err)
+  const html = file.toString()
 
-    const html = result.file.toString()
-    const video = result.video
-
-    // Let Angular application handle errors
-    if (!video) return res.sendFile(indexPath)
+  // Let Angular application handle errors
+  if (!video || video.privacy === VideoPrivacy.PRIVATE) return res.sendFile(getIndexPath(req))
 
-    const htmlStringPageWithTags = addOpenGraphTags(html, video)
-    res.set('Content-Type', 'text/html; charset=UTF-8').send(htmlStringPageWithTags)
-  })
+  const htmlStringPageWithTags = addOpenGraphAndOEmbedTags(html, video)
+  res.set('Content-Type', 'text/html; charset=UTF-8').send(htmlStringPageWithTags)
 }