server/helpers/custom-validators/activitypub/videos.ts

   1 import validator from 'validator'
   2 import { logger } from '@server/helpers/logger'
   3 import { ActivityTrackerUrlObject, ActivityVideoFileMetadataUrlObject } from '@shared/models'
   4 import { VideoState } from '../../../../shared/models/videos'
   5 import { ACTIVITY_PUB, CONSTRAINTS_FIELDS } from '../../../initializers/constants'
   6 import { peertubeTruncate } from '../../core-utils'
   7 import { exists, isArray, isBooleanValid, isDateValid, isUUIDValid } from '../misc'
   8 import {
   9   isVideoDurationValid,
  10   isVideoNameValid,
  11   isVideoStateValid,
  12   isVideoTagValid,
  13   isVideoTruncatedDescriptionValid,
  14   isVideoViewsValid
  15 } from '../videos'
  16 import { isActivityPubUrlValid, isBaseActivityValid, setValidAttributedTo } from './misc'
  17
  18 function sanitizeAndCheckVideoTorrentUpdateActivity (activity: any) {
  19   return isBaseActivityValid(activity, 'Update') &&
  20     sanitizeAndCheckVideoTorrentObject(activity.object)
  21 }
  22
  23 function isActivityPubVideoDurationValid (value: string) {
  24   // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
  25   return exists(value) &&
  26     typeof value === 'string' &&
  27     value.startsWith('PT') &&
  28     value.endsWith('S') &&
  29     isVideoDurationValid(value.replace(/[^0-9]+/g, ''))
  30 }
  31
  32 function sanitizeAndCheckVideoTorrentObject (video: any) {
  33   if (!video || video.type !== 'Video') return false
  34
  35   if (!setValidRemoteTags(video)) {
  36     logger.debug('Video has invalid tags', { video })
  37     return false
  38   }
  39   if (!setValidRemoteVideoUrls(video)) {
  40     logger.debug('Video has invalid urls', { video })
  41     return false
  42   }
  43   if (!setRemoteVideoTruncatedContent(video)) {
  44     logger.debug('Video has invalid content', { video })
  45     return false
  46   }
  47   if (!setValidAttributedTo(video)) {
  48     logger.debug('Video has invalid attributedTo', { video })
  49     return false
  50   }
  51   if (!setValidRemoteCaptions(video)) {
  52     logger.debug('Video has invalid captions', { video })
  53     return false
  54   }
  55   if (!setValidRemoteIcon(video)) {
  56     logger.debug('Video has invalid icons', { video })
  57     return false
  58   }
  59
  60   // Default attributes
  61   if (!isVideoStateValid(video.state)) video.state = VideoState.PUBLISHED
  62   if (!isBooleanValid(video.waitTranscoding)) video.waitTranscoding = false
  63   if (!isBooleanValid(video.downloadEnabled)) video.downloadEnabled = true
  64   if (!isBooleanValid(video.commentsEnabled)) video.commentsEnabled = false
  65   if (!isBooleanValid(video.isLiveBroadcast)) video.isLiveBroadcast = false
  66   if (!isBooleanValid(video.liveSaveReplay)) video.liveSaveReplay = false
  67   if (!isBooleanValid(video.permanentLive)) video.permanentLive = false
  68
  69   return isActivityPubUrlValid(video.id) &&
  70     isVideoNameValid(video.name) &&
  71     isActivityPubVideoDurationValid(video.duration) &&
  72     isUUIDValid(video.uuid) &&
  73     (!video.category || isRemoteNumberIdentifierValid(video.category)) &&
  74     (!video.licence || isRemoteNumberIdentifierValid(video.licence)) &&
  75     (!video.language || isRemoteStringIdentifierValid(video.language)) &&
  76     isVideoViewsValid(video.views) &&
  77     isBooleanValid(video.sensitive) &&
  78     isDateValid(video.published) &&
  79     isDateValid(video.updated) &&
  80     (!video.originallyPublishedAt || isDateValid(video.originallyPublishedAt)) &&
  81     (!video.content || isRemoteVideoContentValid(video.mediaType, video.content)) &&
  82     video.attributedTo.length !== 0
  83 }
  84
  85 function isRemoteVideoUrlValid (url: any) {
  86   return url.type === 'Link' &&
  87     // Video file link
  88     (
  89       ACTIVITY_PUB.URL_MIME_TYPES.VIDEO.includes(url.mediaType) &&
  90       isActivityPubUrlValid(url.href) &&
  91       validator.isInt(url.height + '', { min: 0 }) &&
  92       validator.isInt(url.size + '', { min: 0 }) &&
  93       (!url.fps || validator.isInt(url.fps + '', { min: -1 }))
  94     ) ||
  95     // Torrent link
  96     (
  97       ACTIVITY_PUB.URL_MIME_TYPES.TORRENT.includes(url.mediaType) &&
  98       isActivityPubUrlValid(url.href) &&
  99       validator.isInt(url.height + '', { min: 0 })
 100     ) ||
 101     // Magnet link
 102     (
 103       ACTIVITY_PUB.URL_MIME_TYPES.MAGNET.includes(url.mediaType) &&
 104       validator.isLength(url.href, { min: 5 }) &&
 105       validator.isInt(url.height + '', { min: 0 })
 106     ) ||
 107     // HLS playlist link
 108     (
 109       (url.mediaType || url.mimeType) === 'application/x-mpegURL' &&
 110       isActivityPubUrlValid(url.href) &&
 111       isArray(url.tag)
 112     ) ||
 113     isAPVideoTrackerUrlObject(url) ||
 114     isAPVideoFileUrlMetadataObject(url)
 115 }
 116
 117 function isAPVideoFileUrlMetadataObject (url: any): url is ActivityVideoFileMetadataUrlObject {
 118   return url &&
 119     url.type === 'Link' &&
 120     url.mediaType === 'application/json' &&
 121     isArray(url.rel) && url.rel.includes('metadata')
 122 }
 123
 124 function isAPVideoTrackerUrlObject (url: any): url is ActivityTrackerUrlObject {
 125   return isArray(url.rel) &&
 126     url.rel.includes('tracker') &&
 127     isActivityPubUrlValid(url.href)
 128 }
 129
 130 // ---------------------------------------------------------------------------
 131
 132 export {
 133   sanitizeAndCheckVideoTorrentUpdateActivity,
 134   isRemoteStringIdentifierValid,
 135   sanitizeAndCheckVideoTorrentObject,
 136   isRemoteVideoUrlValid,
 137   isAPVideoFileUrlMetadataObject,
 138   isAPVideoTrackerUrlObject
 139 }
 140
 141 // ---------------------------------------------------------------------------
 142
 143 function setValidRemoteTags (video: any) {
 144   if (Array.isArray(video.tag) === false) return false
 145
 146   video.tag = video.tag.filter(t => {
 147     return t.type === 'Hashtag' &&
 148       isVideoTagValid(t.name)
 149   })
 150
 151   return true
 152 }
 153
 154 function setValidRemoteCaptions (video: any) {
 155   if (!video.subtitleLanguage) video.subtitleLanguage = []
 156
 157   if (Array.isArray(video.subtitleLanguage) === false) return false
 158
 159   video.subtitleLanguage = video.subtitleLanguage.filter(caption => {
 160     if (!isActivityPubUrlValid(caption.url)) caption.url = null
 161
 162     return isRemoteStringIdentifierValid(caption)
 163   })
 164
 165   return true
 166 }
 167
 168 function isRemoteNumberIdentifierValid (data: any) {
 169   return validator.isInt(data.identifier, { min: 0 })
 170 }
 171
 172 function isRemoteStringIdentifierValid (data: any) {
 173   return typeof data.identifier === 'string'
 174 }
 175
 176 function isRemoteVideoContentValid (mediaType: string, content: string) {
 177   return mediaType === 'text/markdown' && isVideoTruncatedDescriptionValid(content)
 178 }
 179
 180 function setValidRemoteIcon (video: any) {
 181   if (video.icon && !isArray(video.icon)) video.icon = [ video.icon ]
 182   if (!video.icon) video.icon = []
 183
 184   video.icon = video.icon.filter(icon => {
 185     return icon.type === 'Image' &&
 186       isActivityPubUrlValid(icon.url) &&
 187       icon.mediaType === 'image/jpeg' &&
 188       validator.isInt(icon.width + '', { min: 0 }) &&
 189       validator.isInt(icon.height + '', { min: 0 })
 190   })
 191
 192   return video.icon.length !== 0
 193 }
 194
 195 function setValidRemoteVideoUrls (video: any) {
 196   if (Array.isArray(video.url) === false) return false
 197
 198   video.url = video.url.filter(u => isRemoteVideoUrlValid(u))
 199
 200   return true
 201 }
 202
 203 function setRemoteVideoTruncatedContent (video: any) {
 204   if (video.content) {
 205     video.content = peertubeTruncate(video.content, { length: CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max })
 206   }
 207
 208   return true
 209 }