server/middlewares/validators/oembed.ts

   1 import express from 'express'
   2 import { query } from 'express-validator'
   3 import { join } from 'path'
   4 import { loadVideo } from '@server/lib/model-loaders'
   5 import { VideoPlaylistModel } from '@server/models/video/video-playlist'
   6 import { VideoPlaylistPrivacy, VideoPrivacy } from '@shared/models'
   7 import { HttpStatusCode } from '../../../shared/models/http/http-error-codes'
   8 import { isTestInstance } from '../../helpers/core-utils'
   9 import { isIdOrUUIDValid, toCompleteUUID } from '../../helpers/custom-validators/misc'
  10 import { logger } from '../../helpers/logger'
  11 import { WEBSERVER } from '../../initializers/constants'
  12 import { areValidationErrors } from './shared'
  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.fail({
  55         status: HttpStatusCode.NOT_IMPLEMENTED_501,
  56         message: 'Requested format is not implemented on server.',
  57         data: {
  58           format: req.query.format
  59         }
  60       })
  61     }
  62
  63     const url = req.query.url as string
  64
  65     let urlPath: string
  66
  67     try {
  68       urlPath = new URL(url).pathname
  69     } catch (err) {
  70       return res.fail({
  71         status: HttpStatusCode.BAD_REQUEST_400,
  72         message: err.message,
  73         data: {
  74           url
  75         }
  76       })
  77     }
  78
  79     const isPlaylist = startPlaylistURLs.some(u => url.startsWith(u))
  80     const isVideo = isPlaylist ? false : startVideoURLs.some(u => url.startsWith(u))
  81
  82     const startIsOk = isVideo || isPlaylist
  83
  84     const matches = watchRegex.exec(urlPath)
  85
  86     if (startIsOk === false || matches === null) {
  87       return res.fail({
  88         status: HttpStatusCode.BAD_REQUEST_400,
  89         message: 'Invalid url.',
  90         data: {
  91           url
  92         }
  93       })
  94     }
  95
  96     const elementId = toCompleteUUID(matches[1])
  97     if (isIdOrUUIDValid(elementId) === false) {
  98       return res.fail({ message: 'Invalid video or playlist id.' })
  99     }
 100
 101     if (isVideo) {
 102       const video = await loadVideo(elementId, 'all')
 103
 104       if (!video) {
 105         return res.fail({
 106           status: HttpStatusCode.NOT_FOUND_404,
 107           message: 'Video not found'
 108         })
 109       }
 110
 111       if (video.privacy !== VideoPrivacy.PUBLIC) {
 112         return res.fail({
 113           status: HttpStatusCode.FORBIDDEN_403,
 114           message: 'Video is not public'
 115         })
 116       }
 117
 118       res.locals.videoAll = video
 119       return next()
 120     }
 121
 122     // Is playlist
 123
 124     const videoPlaylist = await VideoPlaylistModel.loadWithAccountAndChannelSummary(elementId, undefined)
 125     if (!videoPlaylist) {
 126       return res.fail({
 127         status: HttpStatusCode.NOT_FOUND_404,
 128         message: 'Video playlist not found'
 129       })
 130     }
 131
 132     if (videoPlaylist.privacy !== VideoPlaylistPrivacy.PUBLIC) {
 133       return res.fail({
 134         status: HttpStatusCode.FORBIDDEN_403,
 135         message: 'Playlist is not public'
 136       })
 137     }
 138
 139     res.locals.videoPlaylistSummary = videoPlaylist
 140     return next()
 141   }
 142
 143 ]
 144
 145 // ---------------------------------------------------------------------------
 146
 147 export {
 148   oembedValidator
 149 }