server/middlewares/validators/oembed.ts

   1 import * as express from 'express'
   2 import { query } from 'express-validator'
   3 import { join } from 'path'
   4 import { fetchVideo } from '@server/helpers/video'
   5 import { VideoPlaylistModel } from '@server/models/video/video-playlist'
   6 import { VideoPlaylistPrivacy, VideoPrivacy } from '@shared/models'
   7 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
   8 import { isTestInstance } from '../../helpers/core-utils'
   9 import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc'
  10 import { logger } from '../../helpers/logger'
  11 import { WEBSERVER } from '../../initializers/constants'
  12 import { areValidationErrors } from './utils'
  13
  14 const playlistPaths = [
  15   join('videos', 'watch', 'playlist'),
  16   join('w', 'p')
  17 ]
  18
  19 const videoPaths = [
  20   join('videos', 'watch'),
  21   'w'
  22 ]
  23
  24 function buildUrls (paths: string[]) {
  25   return paths.map(p => WEBSERVER.SCHEME + '://' + join(WEBSERVER.HOST, p) + '/')
  26 }
  27
  28 const startPlaylistURLs = buildUrls(playlistPaths)
  29 const startVideoURLs = buildUrls(videoPaths)
  30
  31 const watchRegex = /([^/]+)$/
  32 const isURLOptions = {
  33   require_host: true,
  34   require_tld: true
  35 }
  36
  37 // We validate 'localhost', so we don't have the top level domain
  38 if (isTestInstance()) {
  39   isURLOptions.require_tld = false
  40 }
  41
  42 const oembedValidator = [
  43   query('url').isURL(isURLOptions).withMessage('Should have a valid url'),
  44   query('maxwidth').optional().isInt().withMessage('Should have a valid max width'),
  45   query('maxheight').optional().isInt().withMessage('Should have a valid max height'),
  46   query('format').optional().isIn([ 'xml', 'json' ]).withMessage('Should have a valid format'),
  47
  48   async (req: express.Request, res: express.Response, next: express.NextFunction) => {
  49     logger.debug('Checking oembed parameters', { parameters: req.query })
  50
  51     if (areValidationErrors(req, res)) return
  52
  53     if (req.query.format !== undefined && req.query.format !== 'json') {
  54       return res.status(HttpStatusCode.NOT_IMPLEMENTED_501)
  55         .json({ error: 'Requested format is not implemented on server.' })
  56     }
  57
  58     const url = req.query.url as string
  59
  60     const isPlaylist = startPlaylistURLs.some(u => url.startsWith(u))
  61     const isVideo = isPlaylist ? false : startVideoURLs.some(u => url.startsWith(u))
  62
  63     const startIsOk = isVideo || isPlaylist
  64
  65     const matches = watchRegex.exec(url)
  66
  67     if (startIsOk === false || matches === null) {
  68       return res.status(HttpStatusCode.BAD_REQUEST_400)
  69         .json({ error: 'Invalid url.' })
  70     }
  71
  72     const elementId = matches[1]
  73     if (isIdOrUUIDValid(elementId) === false) {
  74       return res.status(HttpStatusCode.BAD_REQUEST_400)
  75         .json({ error: 'Invalid video or playlist id.' })
  76     }
  77
  78     if (isVideo) {
  79       const video = await fetchVideo(elementId, 'all')
  80
  81       if (!video) {
  82         return res.status(HttpStatusCode.NOT_FOUND_404)
  83           .json({ error: 'Video not found' })
  84       }
  85
  86       if (video.privacy !== VideoPrivacy.PUBLIC) {
  87         return res.status(HttpStatusCode.FORBIDDEN_403)
  88           .json({ error: 'Video is not public' })
  89       }
  90
  91       res.locals.videoAll = video
  92       return next()
  93     }
  94
  95     // Is playlist
  96
  97     const videoPlaylist = await VideoPlaylistModel.loadWithAccountAndChannelSummary(elementId, undefined)
  98     if (!videoPlaylist) {
  99       return res.status(HttpStatusCode.NOT_FOUND_404)
 100         .json({ error: 'Video playlist not found' })
 101     }
 102
 103     if (videoPlaylist.privacy !== VideoPlaylistPrivacy.PUBLIC) {
 104       return res.status(HttpStatusCode.FORBIDDEN_403)
 105         .json({ error: 'Playlist is not public' })
 106     }
 107
 108     res.locals.videoPlaylistSummary = videoPlaylist
 109     return next()
 110   }
 111
 112 ]
 113
 114 // ---------------------------------------------------------------------------
 115
 116 export {
 117   oembedValidator
 118 }