server/lib/activitypub/videos.ts

   1 import * as Bluebird from 'bluebird'
   2 import { maxBy, minBy } from 'lodash'
   3 import * as magnetUtil from 'magnet-uri'
   4 import { join } from 'path'
   5 import * as request from 'request'
   6 import * as sequelize from 'sequelize'
   7 import {
   8   ActivityHashTagObject,
   9   ActivityMagnetUrlObject,
  10   ActivityPlaylistSegmentHashesObject,
  11   ActivityPlaylistUrlObject,
  12   ActivitypubHttpFetcherPayload,
  13   ActivityTagObject,
  14   ActivityUrlObject,
  15   ActivityVideoUrlObject,
  16   VideoState
  17 } from '../../../shared/index'
  18 import { VideoObject } from '../../../shared/models/activitypub/objects'
  19 import { VideoPrivacy } from '../../../shared/models/videos'
  20 import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
  21 import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
  22 import { buildRemoteVideoBaseUrl, checkUrlsSameHost, getAPId } from '../../helpers/activitypub'
  23 import { isAPVideoFileMetadataObject, sanitizeAndCheckVideoTorrentObject } from '../../helpers/custom-validators/activitypub/videos'
  24 import { isArray } from '../../helpers/custom-validators/misc'
  25 import { isVideoFileInfoHashValid } from '../../helpers/custom-validators/videos'
  26 import { deleteNonExistingModels, resetSequelizeInstance, retryTransactionWrapper } from '../../helpers/database-utils'
  27 import { logger } from '../../helpers/logger'
  28 import { doRequest } from '../../helpers/requests'
  29 import { fetchVideoByUrl, getExtFromMimetype, VideoFetchByUrlType } from '../../helpers/video'
  30 import {
  31   ACTIVITY_PUB,
  32   MIMETYPES,
  33   P2P_MEDIA_LOADER_PEER_VERSION,
  34   PREVIEWS_SIZE,
  35   REMOTE_SCHEME,
  36   STATIC_PATHS,
  37   THUMBNAILS_SIZE
  38 } from '../../initializers/constants'
  39 import { sequelizeTypescript } from '../../initializers/database'
  40 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
  41 import { VideoModel } from '../../models/video/video'
  42 import { VideoCaptionModel } from '../../models/video/video-caption'
  43 import { VideoCommentModel } from '../../models/video/video-comment'
  44 import { VideoFileModel } from '../../models/video/video-file'
  45 import { VideoShareModel } from '../../models/video/video-share'
  46 import { VideoStreamingPlaylistModel } from '../../models/video/video-streaming-playlist'
  47 import {
  48   MAccountIdActor,
  49   MChannelAccountLight,
  50   MChannelDefault,
  51   MChannelId,
  52   MStreamingPlaylist,
  53   MVideo,
  54   MVideoAccountLight,
  55   MVideoAccountLightBlacklistAllFiles,
  56   MVideoAP,
  57   MVideoAPWithoutCaption,
  58   MVideoFile,
  59   MVideoFullLight,
  60   MVideoId,
  61   MVideoImmutable,
  62   MVideoThumbnail
  63 } from '../../types/models'
  64 import { MThumbnail } from '../../types/models/video/thumbnail'
  65 import { FilteredModelAttributes } from '../../types/sequelize'
  66 import { ActorFollowScoreCache } from '../files-cache'
  67 import { JobQueue } from '../job-queue'
  68 import { Notifier } from '../notifier'
  69 import { PeerTubeSocket } from '../peertube-socket'
  70 import { createPlaceholderThumbnail, createVideoMiniatureFromUrl } from '../thumbnail'
  71 import { setVideoTags } from '../video'
  72 import { autoBlacklistVideoIfNeeded } from '../video-blacklist'
  73 import { getOrCreateActorAndServerAndModel } from './actor'
  74 import { crawlCollectionPage } from './crawl'
  75 import { sendCreateVideo, sendUpdateVideo } from './send'
  76 import { addVideoShares, shareVideoByServerAndChannel } from './share'
  77 import { addVideoComments } from './video-comments'
  78 import { createRates } from './video-rates'
  79
  80 async function federateVideoIfNeeded (videoArg: MVideoAPWithoutCaption, isNewVideo: boolean, transaction?: sequelize.Transaction) {
  81   const video = videoArg as MVideoAP
  82
  83   if (
  84     // Check this is not a blacklisted video, or unfederated blacklisted video
  85     (video.isBlacklisted() === false || (isNewVideo === false && video.VideoBlacklist.unfederated === false)) &&
  86     // Check the video is public/unlisted and published
  87     video.hasPrivacyForFederation() && video.state === VideoState.PUBLISHED
  88   ) {
  89     // Fetch more attributes that we will need to serialize in AP object
  90     if (isArray(video.VideoCaptions) === false) {
  91       video.VideoCaptions = await video.$get('VideoCaptions', {
  92         attributes: [ 'language' ],
  93         transaction
  94       })
  95     }
  96
  97     if (isNewVideo) {
  98       // Now we'll add the video's meta data to our followers
  99       await sendCreateVideo(video, transaction)
 100       await shareVideoByServerAndChannel(video, transaction)
 101     } else {
 102       await sendUpdateVideo(video, transaction)
 103     }
 104   }
 105 }
 106
 107 async function fetchRemoteVideo (videoUrl: string): Promise<{ response: request.RequestResponse, videoObject: VideoObject }> {
 108   const options = {
 109     uri: videoUrl,
 110     method: 'GET',
 111     json: true,
 112     activityPub: true
 113   }
 114
 115   logger.info('Fetching remote video %s.', videoUrl)
 116
 117   const { response, body } = await doRequest<any>(options)
 118
 119   if (sanitizeAndCheckVideoTorrentObject(body) === false || checkUrlsSameHost(body.id, videoUrl) !== true) {
 120     logger.debug('Remote video JSON is not valid.', { body })
 121     return { response, videoObject: undefined }
 122   }
 123
 124   return { response, videoObject: body }
 125 }
 126
 127 async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
 128   const host = video.VideoChannel.Account.Actor.Server.host
 129   const path = video.getDescriptionAPIPath()
 130   const options = {
 131     uri: REMOTE_SCHEME.HTTP + '://' + host + path,
 132     json: true
 133   }
 134
 135   const { body } = await doRequest<any>(options)
 136   return body.description ? body.description : ''
 137 }
 138
 139 function getOrCreateVideoChannelFromVideoObject (videoObject: VideoObject) {
 140   const channel = videoObject.attributedTo.find(a => a.type === 'Group')
 141   if (!channel) throw new Error('Cannot find associated video channel to video ' + videoObject.url)
 142
 143   if (checkUrlsSameHost(channel.id, videoObject.id) !== true) {
 144     throw new Error(`Video channel url ${channel.id} does not have the same host than video object id ${videoObject.id}`)
 145   }
 146
 147   return getOrCreateActorAndServerAndModel(channel.id, 'all')
 148 }
 149
 150 type SyncParam = {
 151   likes: boolean
 152   dislikes: boolean
 153   shares: boolean
 154   comments: boolean
 155   thumbnail: boolean
 156   refreshVideo?: boolean
 157 }
 158 async function syncVideoExternalAttributes (video: MVideo, fetchedVideo: VideoObject, syncParam: SyncParam) {
 159   logger.info('Adding likes/dislikes/shares/comments of video %s.', video.uuid)
 160
 161   const jobPayloads: ActivitypubHttpFetcherPayload[] = []
 162
 163   if (syncParam.likes === true) {
 164     const handler = items => createRates(items, video, 'like')
 165     const cleaner = crawlStartDate => AccountVideoRateModel.cleanOldRatesOf(video.id, 'like' as 'like', crawlStartDate)
 166
 167     await crawlCollectionPage<string>(fetchedVideo.likes, handler, cleaner)
 168       .catch(err => logger.error('Cannot add likes of video %s.', video.uuid, { err, rootUrl: fetchedVideo.likes }))
 169   } else {
 170     jobPayloads.push({ uri: fetchedVideo.likes, videoId: video.id, type: 'video-likes' as 'video-likes' })
 171   }
 172
 173   if (syncParam.dislikes === true) {
 174     const handler = items => createRates(items, video, 'dislike')
 175     const cleaner = crawlStartDate => AccountVideoRateModel.cleanOldRatesOf(video.id, 'dislike' as 'dislike', crawlStartDate)
 176
 177     await crawlCollectionPage<string>(fetchedVideo.dislikes, handler, cleaner)
 178       .catch(err => logger.error('Cannot add dislikes of video %s.', video.uuid, { err, rootUrl: fetchedVideo.dislikes }))
 179   } else {
 180     jobPayloads.push({ uri: fetchedVideo.dislikes, videoId: video.id, type: 'video-dislikes' as 'video-dislikes' })
 181   }
 182
 183   if (syncParam.shares === true) {
 184     const handler = items => addVideoShares(items, video)
 185     const cleaner = crawlStartDate => VideoShareModel.cleanOldSharesOf(video.id, crawlStartDate)
 186
 187     await crawlCollectionPage<string>(fetchedVideo.shares, handler, cleaner)
 188       .catch(err => logger.error('Cannot add shares of video %s.', video.uuid, { err, rootUrl: fetchedVideo.shares }))
 189   } else {
 190     jobPayloads.push({ uri: fetchedVideo.shares, videoId: video.id, type: 'video-shares' as 'video-shares' })
 191   }
 192
 193   if (syncParam.comments === true) {
 194     const handler = items => addVideoComments(items)
 195     const cleaner = crawlStartDate => VideoCommentModel.cleanOldCommentsOf(video.id, crawlStartDate)
 196
 197     await crawlCollectionPage<string>(fetchedVideo.comments, handler, cleaner)
 198       .catch(err => logger.error('Cannot add comments of video %s.', video.uuid, { err, rootUrl: fetchedVideo.comments }))
 199   } else {
 200     jobPayloads.push({ uri: fetchedVideo.comments, videoId: video.id, type: 'video-comments' as 'video-comments' })
 201   }
 202
 203   await Bluebird.map(jobPayloads, payload => JobQueue.Instance.createJobWithPromise({ type: 'activitypub-http-fetcher', payload }))
 204 }
 205
 206 type GetVideoResult <T> = Promise<{
 207   video: T
 208   created: boolean
 209   autoBlacklisted?: boolean
 210 }>
 211
 212 type GetVideoParamAll = {
 213   videoObject: { id: string } | string
 214   syncParam?: SyncParam
 215   fetchType?: 'all'
 216   allowRefresh?: boolean
 217 }
 218
 219 type GetVideoParamImmutable = {
 220   videoObject: { id: string } | string
 221   syncParam?: SyncParam
 222   fetchType: 'only-immutable-attributes'
 223   allowRefresh: false
 224 }
 225
 226 type GetVideoParamOther = {
 227   videoObject: { id: string } | string
 228   syncParam?: SyncParam
 229   fetchType?: 'all' | 'only-video'
 230   allowRefresh?: boolean
 231 }
 232
 233 function getOrCreateVideoAndAccountAndChannel (options: GetVideoParamAll): GetVideoResult<MVideoAccountLightBlacklistAllFiles>
 234 function getOrCreateVideoAndAccountAndChannel (options: GetVideoParamImmutable): GetVideoResult<MVideoImmutable>
 235 function getOrCreateVideoAndAccountAndChannel (
 236   options: GetVideoParamOther
 237 ): GetVideoResult<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail>
 238 async function getOrCreateVideoAndAccountAndChannel (
 239   options: GetVideoParamAll | GetVideoParamImmutable | GetVideoParamOther
 240 ): GetVideoResult<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail | MVideoImmutable> {
 241   // Default params
 242   const syncParam = options.syncParam || { likes: true, dislikes: true, shares: true, comments: true, thumbnail: true, refreshVideo: false }
 243   const fetchType = options.fetchType || 'all'
 244   const allowRefresh = options.allowRefresh !== false
 245
 246   // Get video url
 247   const videoUrl = getAPId(options.videoObject)
 248   let videoFromDatabase = await fetchVideoByUrl(videoUrl, fetchType)
 249
 250   if (videoFromDatabase) {
 251     // If allowRefresh is true, we could not call this function using 'only-immutable-attributes' fetch type
 252     if (allowRefresh === true && (videoFromDatabase as MVideoThumbnail).isOutdated()) {
 253       const refreshOptions = {
 254         video: videoFromDatabase as MVideoThumbnail,
 255         fetchedType: fetchType,
 256         syncParam
 257       }
 258
 259       if (syncParam.refreshVideo === true) {
 260         videoFromDatabase = await refreshVideoIfNeeded(refreshOptions)
 261       } else {
 262         await JobQueue.Instance.createJobWithPromise({
 263           type: 'activitypub-refresher',
 264           payload: { type: 'video', url: videoFromDatabase.url }
 265         })
 266       }
 267     }
 268
 269     return { video: videoFromDatabase, created: false }
 270   }
 271
 272   const { videoObject: fetchedVideo } = await fetchRemoteVideo(videoUrl)
 273   if (!fetchedVideo) throw new Error('Cannot fetch remote video with url: ' + videoUrl)
 274
 275   const actor = await getOrCreateVideoChannelFromVideoObject(fetchedVideo)
 276   const videoChannel = actor.VideoChannel
 277
 278   try {
 279     const { autoBlacklisted, videoCreated } = await retryTransactionWrapper(createVideo, fetchedVideo, videoChannel, syncParam.thumbnail)
 280
 281     await syncVideoExternalAttributes(videoCreated, fetchedVideo, syncParam)
 282
 283     return { video: videoCreated, created: true, autoBlacklisted }
 284   } catch (err) {
 285     // Maybe a concurrent getOrCreateVideoAndAccountAndChannel call created this video
 286     if (err.name === 'SequelizeUniqueConstraintError') {
 287       const fallbackVideo = await fetchVideoByUrl(videoUrl, fetchType)
 288       if (fallbackVideo) return { video: fallbackVideo, created: false }
 289     }
 290
 291     throw err
 292   }
 293 }
 294
 295 async function updateVideoFromAP (options: {
 296   video: MVideoAccountLightBlacklistAllFiles
 297   videoObject: VideoObject
 298   account: MAccountIdActor
 299   channel: MChannelDefault
 300   overrideTo?: string[]
 301 }) {
 302   const { video, videoObject, account, channel, overrideTo } = options
 303
 304   logger.debug('Updating remote video "%s".', options.videoObject.uuid, { account, channel })
 305
 306   let videoFieldsSave: any
 307   const wasPrivateVideo = video.privacy === VideoPrivacy.PRIVATE
 308   const wasUnlistedVideo = video.privacy === VideoPrivacy.UNLISTED
 309
 310   try {
 311     let thumbnailModel: MThumbnail
 312
 313     try {
 314       thumbnailModel = await createVideoMiniatureFromUrl(getThumbnailFromIcons(videoObject).url, video, ThumbnailType.MINIATURE)
 315     } catch (err) {
 316       logger.warn('Cannot generate thumbnail of %s.', videoObject.id, { err })
 317     }
 318
 319     const videoUpdated = await sequelizeTypescript.transaction(async t => {
 320       const sequelizeOptions = { transaction: t }
 321
 322       videoFieldsSave = video.toJSON()
 323
 324       // Check actor has the right to update the video
 325       const videoChannel = video.VideoChannel
 326       if (videoChannel.Account.id !== account.id) {
 327         throw new Error('Account ' + account.Actor.url + ' does not own video channel ' + videoChannel.Actor.url)
 328       }
 329
 330       const to = overrideTo || videoObject.to
 331       const videoData = await videoActivityObjectToDBAttributes(channel, videoObject, to)
 332       video.name = videoData.name
 333       video.uuid = videoData.uuid
 334       video.url = videoData.url
 335       video.category = videoData.category
 336       video.licence = videoData.licence
 337       video.language = videoData.language
 338       video.description = videoData.description
 339       video.support = videoData.support
 340       video.nsfw = videoData.nsfw
 341       video.commentsEnabled = videoData.commentsEnabled
 342       video.downloadEnabled = videoData.downloadEnabled
 343       video.waitTranscoding = videoData.waitTranscoding
 344       video.state = videoData.state
 345       video.duration = videoData.duration
 346       video.createdAt = videoData.createdAt
 347       video.publishedAt = videoData.publishedAt
 348       video.originallyPublishedAt = videoData.originallyPublishedAt
 349       video.privacy = videoData.privacy
 350       video.channelId = videoData.channelId
 351       video.views = videoData.views
 352       video.isLive = videoData.isLive
 353
 354       const videoUpdated = await video.save(sequelizeOptions) as MVideoFullLight
 355
 356       if (thumbnailModel) await videoUpdated.addAndSaveThumbnail(thumbnailModel, t)
 357
 358       if (videoUpdated.getPreview()) {
 359         const previewUrl = videoUpdated.getPreview().getFileUrl(videoUpdated)
 360         const previewModel = createPlaceholderThumbnail(previewUrl, video, ThumbnailType.PREVIEW, PREVIEWS_SIZE)
 361         await videoUpdated.addAndSaveThumbnail(previewModel, t)
 362       }
 363
 364       {
 365         const videoFileAttributes = videoFileActivityUrlToDBAttributes(videoUpdated, videoObject.url)
 366         const newVideoFiles = videoFileAttributes.map(a => new VideoFileModel(a))
 367
 368         // Remove video files that do not exist anymore
 369         const destroyTasks = deleteNonExistingModels(videoUpdated.VideoFiles, newVideoFiles, t)
 370         await Promise.all(destroyTasks)
 371
 372         // Update or add other one
 373         const upsertTasks = newVideoFiles.map(f => VideoFileModel.customUpsert(f, 'video', t))
 374         videoUpdated.VideoFiles = await Promise.all(upsertTasks)
 375       }
 376
 377       {
 378         const streamingPlaylistAttributes = streamingPlaylistActivityUrlToDBAttributes(videoUpdated, videoObject, videoUpdated.VideoFiles)
 379         const newStreamingPlaylists = streamingPlaylistAttributes.map(a => new VideoStreamingPlaylistModel(a))
 380
 381         // Remove video playlists that do not exist anymore
 382         const destroyTasks = deleteNonExistingModels(videoUpdated.VideoStreamingPlaylists, newStreamingPlaylists, t)
 383         await Promise.all(destroyTasks)
 384
 385         let oldStreamingPlaylistFiles: MVideoFile[] = []
 386         for (const videoStreamingPlaylist of videoUpdated.VideoStreamingPlaylists) {
 387           oldStreamingPlaylistFiles = oldStreamingPlaylistFiles.concat(videoStreamingPlaylist.VideoFiles)
 388         }
 389
 390         videoUpdated.VideoStreamingPlaylists = []
 391
 392         for (const playlistAttributes of streamingPlaylistAttributes) {
 393           const streamingPlaylistModel = await VideoStreamingPlaylistModel.upsert(playlistAttributes, { returning: true, transaction: t })
 394                                      .then(([ streamingPlaylist ]) => streamingPlaylist)
 395
 396           const newVideoFiles: MVideoFile[] = videoFileActivityUrlToDBAttributes(streamingPlaylistModel, playlistAttributes.tagAPObject)
 397             .map(a => new VideoFileModel(a))
 398           const destroyTasks = deleteNonExistingModels(oldStreamingPlaylistFiles, newVideoFiles, t)
 399           await Promise.all(destroyTasks)
 400
 401           // Update or add other one
 402           const upsertTasks = newVideoFiles.map(f => VideoFileModel.customUpsert(f, 'streaming-playlist', t))
 403           streamingPlaylistModel.VideoFiles = await Promise.all(upsertTasks)
 404
 405           videoUpdated.VideoStreamingPlaylists.push(streamingPlaylistModel)
 406         }
 407       }
 408
 409       {
 410         // Update Tags
 411         const tags = videoObject.tag
 412                                 .filter(isAPHashTagObject)
 413                                 .map(tag => tag.name)
 414         await setVideoTags({ video: videoUpdated, tags, transaction: t, defaultValue: videoUpdated.Tags })
 415       }
 416
 417       {
 418         // Update captions
 419         await VideoCaptionModel.deleteAllCaptionsOfRemoteVideo(videoUpdated.id, t)
 420
 421         const videoCaptionsPromises = videoObject.subtitleLanguage.map(c => {
 422           return VideoCaptionModel.insertOrReplaceLanguage(videoUpdated.id, c.identifier, c.url, t)
 423         })
 424         await Promise.all(videoCaptionsPromises)
 425       }
 426
 427       return videoUpdated
 428     })
 429
 430     await autoBlacklistVideoIfNeeded({
 431       video: videoUpdated,
 432       user: undefined,
 433       isRemote: true,
 434       isNew: false,
 435       transaction: undefined
 436     })
 437
 438     if (wasPrivateVideo || wasUnlistedVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoUpdated) // Notify our users?
 439     if (videoUpdated.isLive) PeerTubeSocket.Instance.sendVideoLiveNewState(video)
 440
 441     logger.info('Remote video with uuid %s updated', videoObject.uuid)
 442
 443     return videoUpdated
 444   } catch (err) {
 445     if (video !== undefined && videoFieldsSave !== undefined) {
 446       resetSequelizeInstance(video, videoFieldsSave)
 447     }
 448
 449     // This is just a debug because we will retry the insert
 450     logger.debug('Cannot update the remote video.', { err })
 451     throw err
 452   }
 453 }
 454
 455 async function refreshVideoIfNeeded (options: {
 456   video: MVideoThumbnail
 457   fetchedType: VideoFetchByUrlType
 458   syncParam: SyncParam
 459 }): Promise<MVideoThumbnail> {
 460   if (!options.video.isOutdated()) return options.video
 461
 462   // We need more attributes if the argument video was fetched with not enough joints
 463   const video = options.fetchedType === 'all'
 464     ? options.video as MVideoAccountLightBlacklistAllFiles
 465     : await VideoModel.loadByUrlAndPopulateAccount(options.video.url)
 466
 467   try {
 468     const { response, videoObject } = await fetchRemoteVideo(video.url)
 469     if (response.statusCode === 404) {
 470       logger.info('Cannot refresh remote video %s: video does not exist anymore. Deleting it.', video.url)
 471
 472       // Video does not exist anymore
 473       await video.destroy()
 474       return undefined
 475     }
 476
 477     if (videoObject === undefined) {
 478       logger.warn('Cannot refresh remote video %s: invalid body.', video.url)
 479
 480       await video.setAsRefreshed()
 481       return video
 482     }
 483
 484     const channelActor = await getOrCreateVideoChannelFromVideoObject(videoObject)
 485
 486     const updateOptions = {
 487       video,
 488       videoObject,
 489       account: channelActor.VideoChannel.Account,
 490       channel: channelActor.VideoChannel
 491     }
 492     await retryTransactionWrapper(updateVideoFromAP, updateOptions)
 493     await syncVideoExternalAttributes(video, videoObject, options.syncParam)
 494
 495     ActorFollowScoreCache.Instance.addGoodServerId(video.VideoChannel.Actor.serverId)
 496
 497     return video
 498   } catch (err) {
 499     logger.warn('Cannot refresh video %s.', options.video.url, { err })
 500
 501     ActorFollowScoreCache.Instance.addBadServerId(video.VideoChannel.Actor.serverId)
 502
 503     // Don't refresh in loop
 504     await video.setAsRefreshed()
 505     return video
 506   }
 507 }
 508
 509 export {
 510   updateVideoFromAP,
 511   refreshVideoIfNeeded,
 512   federateVideoIfNeeded,
 513   fetchRemoteVideo,
 514   getOrCreateVideoAndAccountAndChannel,
 515   fetchRemoteVideoDescription,
 516   getOrCreateVideoChannelFromVideoObject
 517 }
 518
 519 // ---------------------------------------------------------------------------
 520
 521 function isAPVideoUrlObject (url: any): url is ActivityVideoUrlObject {
 522   const urlMediaType = url.mediaType
 523
 524   return MIMETYPES.VIDEO.MIMETYPE_EXT[urlMediaType] && urlMediaType.startsWith('video/')
 525 }
 526
 527 function isAPStreamingPlaylistUrlObject (url: ActivityUrlObject): url is ActivityPlaylistUrlObject {
 528   return url && url.mediaType === 'application/x-mpegURL'
 529 }
 530
 531 function isAPPlaylistSegmentHashesUrlObject (tag: any): tag is ActivityPlaylistSegmentHashesObject {
 532   return tag && tag.name === 'sha256' && tag.type === 'Link' && tag.mediaType === 'application/json'
 533 }
 534
 535 function isAPMagnetUrlObject (url: any): url is ActivityMagnetUrlObject {
 536   return url && url.mediaType === 'application/x-bittorrent;x-scheme-handler/magnet'
 537 }
 538
 539 function isAPHashTagObject (url: any): url is ActivityHashTagObject {
 540   return url && url.type === 'Hashtag'
 541 }
 542
 543 async function createVideo (videoObject: VideoObject, channel: MChannelAccountLight, waitThumbnail = false) {
 544   logger.debug('Adding remote video %s.', videoObject.id)
 545
 546   const videoData = await videoActivityObjectToDBAttributes(channel, videoObject, videoObject.to)
 547   const video = VideoModel.build(videoData) as MVideoThumbnail
 548
 549   const promiseThumbnail = createVideoMiniatureFromUrl(getThumbnailFromIcons(videoObject).url, video, ThumbnailType.MINIATURE)
 550     .catch(err => {
 551       logger.error('Cannot create miniature from url.', { err })
 552       return undefined
 553     })
 554
 555   let thumbnailModel: MThumbnail
 556   if (waitThumbnail === true) {
 557     thumbnailModel = await promiseThumbnail
 558   }
 559
 560   const { autoBlacklisted, videoCreated } = await sequelizeTypescript.transaction(async t => {
 561     const sequelizeOptions = { transaction: t }
 562
 563     const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
 564     videoCreated.VideoChannel = channel
 565
 566     if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
 567
 568     const previewIcon = getPreviewFromIcons(videoObject)
 569     const previewUrl = previewIcon
 570       ? previewIcon.url
 571       : buildRemoteVideoBaseUrl(videoCreated, join(STATIC_PATHS.PREVIEWS, video.generatePreviewName()))
 572     const previewModel = createPlaceholderThumbnail(previewUrl, videoCreated, ThumbnailType.PREVIEW, PREVIEWS_SIZE)
 573
 574     if (thumbnailModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
 575
 576     // Process files
 577     const videoFileAttributes = videoFileActivityUrlToDBAttributes(videoCreated, videoObject.url)
 578
 579     const videoFilePromises = videoFileAttributes.map(f => VideoFileModel.create(f, { transaction: t }))
 580     const videoFiles = await Promise.all(videoFilePromises)
 581
 582     const streamingPlaylistsAttributes = streamingPlaylistActivityUrlToDBAttributes(videoCreated, videoObject, videoFiles)
 583     videoCreated.VideoStreamingPlaylists = []
 584
 585     for (const playlistAttributes of streamingPlaylistsAttributes) {
 586       const playlistModel = await VideoStreamingPlaylistModel.create(playlistAttributes, { transaction: t })
 587
 588       const playlistFiles = videoFileActivityUrlToDBAttributes(playlistModel, playlistAttributes.tagAPObject)
 589       const videoFilePromises = playlistFiles.map(f => VideoFileModel.create(f, { transaction: t }))
 590       playlistModel.VideoFiles = await Promise.all(videoFilePromises)
 591
 592       videoCreated.VideoStreamingPlaylists.push(playlistModel)
 593     }
 594
 595     // Process tags
 596     const tags = videoObject.tag
 597                             .filter(isAPHashTagObject)
 598                             .map(t => t.name)
 599     await setVideoTags({ video: videoCreated, tags, transaction: t })
 600
 601     // Process captions
 602     const videoCaptionsPromises = videoObject.subtitleLanguage.map(c => {
 603       return VideoCaptionModel.insertOrReplaceLanguage(videoCreated.id, c.identifier, c.url, t)
 604     })
 605     await Promise.all(videoCaptionsPromises)
 606
 607     videoCreated.VideoFiles = videoFiles
 608
 609     const autoBlacklisted = await autoBlacklistVideoIfNeeded({
 610       video: videoCreated,
 611       user: undefined,
 612       isRemote: true,
 613       isNew: true,
 614       transaction: t
 615     })
 616
 617     logger.info('Remote video with uuid %s inserted.', videoObject.uuid)
 618
 619     return { autoBlacklisted, videoCreated }
 620   })
 621
 622   if (waitThumbnail === false) {
 623     // Error is already caught above
 624     // eslint-disable-next-line @typescript-eslint/no-floating-promises
 625     promiseThumbnail.then(thumbnailModel => {
 626       if (!thumbnailModel) return
 627
 628       thumbnailModel = videoCreated.id
 629
 630       return thumbnailModel.save()
 631     })
 632   }
 633
 634   return { autoBlacklisted, videoCreated }
 635 }
 636
 637 function videoActivityObjectToDBAttributes (videoChannel: MChannelId, videoObject: VideoObject, to: string[] = []) {
 638   const privacy = to.includes(ACTIVITY_PUB.PUBLIC)
 639     ? VideoPrivacy.PUBLIC
 640     : VideoPrivacy.UNLISTED
 641
 642   const duration = videoObject.duration.replace(/[^\d]+/, '')
 643   const language = videoObject.language?.identifier
 644
 645   const category = videoObject.category
 646     ? parseInt(videoObject.category.identifier, 10)
 647     : undefined
 648
 649   const licence = videoObject.licence
 650     ? parseInt(videoObject.licence.identifier, 10)
 651     : undefined
 652
 653   const description = videoObject.content || null
 654   const support = videoObject.support || null
 655
 656   return {
 657     name: videoObject.name,
 658     uuid: videoObject.uuid,
 659     url: videoObject.id,
 660     category,
 661     licence,
 662     language,
 663     description,
 664     support,
 665     nsfw: videoObject.sensitive,
 666     commentsEnabled: videoObject.commentsEnabled,
 667     downloadEnabled: videoObject.downloadEnabled,
 668     waitTranscoding: videoObject.waitTranscoding,
 669     isLive: videoObject.isLiveBroadcast,
 670     state: videoObject.state,
 671     channelId: videoChannel.id,
 672     duration: parseInt(duration, 10),
 673     createdAt: new Date(videoObject.published),
 674     publishedAt: new Date(videoObject.published),
 675
 676     originallyPublishedAt: videoObject.originallyPublishedAt
 677       ? new Date(videoObject.originallyPublishedAt)
 678       : null,
 679
 680     updatedAt: new Date(videoObject.updated),
 681     views: videoObject.views,
 682     likes: 0,
 683     dislikes: 0,
 684     remote: true,
 685     privacy
 686   }
 687 }
 688
 689 function videoFileActivityUrlToDBAttributes (
 690   videoOrPlaylist: MVideo | MStreamingPlaylist,
 691   urls: (ActivityTagObject | ActivityUrlObject)[]
 692 ) {
 693   const fileUrls = urls.filter(u => isAPVideoUrlObject(u)) as ActivityVideoUrlObject[]
 694
 695   if (fileUrls.length === 0) return []
 696
 697   const attributes: FilteredModelAttributes<VideoFileModel>[] = []
 698   for (const fileUrl of fileUrls) {
 699     // Fetch associated magnet uri
 700     const magnet = urls.filter(isAPMagnetUrlObject)
 701                        .find(u => u.height === fileUrl.height)
 702
 703     if (!magnet) throw new Error('Cannot find associated magnet uri for file ' + fileUrl.href)
 704
 705     const parsed = magnetUtil.decode(magnet.href)
 706     if (!parsed || isVideoFileInfoHashValid(parsed.infoHash) === false) {
 707       throw new Error('Cannot parse magnet URI ' + magnet.href)
 708     }
 709
 710     // Fetch associated metadata url, if any
 711     const metadata = urls.filter(isAPVideoFileMetadataObject)
 712                          .find(u => {
 713                            return u.height === fileUrl.height &&
 714                              u.fps === fileUrl.fps &&
 715                              u.rel.includes(fileUrl.mediaType)
 716                          })
 717
 718     const mediaType = fileUrl.mediaType
 719     const attribute = {
 720       extname: getExtFromMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT, mediaType),
 721       infoHash: parsed.infoHash,
 722       resolution: fileUrl.height,
 723       size: fileUrl.size,
 724       fps: fileUrl.fps || -1,
 725       metadataUrl: metadata?.href,
 726
 727       // This is a video file owned by a video or by a streaming playlist
 728       videoId: (videoOrPlaylist as MStreamingPlaylist).playlistUrl ? null : videoOrPlaylist.id,
 729       videoStreamingPlaylistId: (videoOrPlaylist as MStreamingPlaylist).playlistUrl ? videoOrPlaylist.id : null
 730     }
 731
 732     attributes.push(attribute)
 733   }
 734
 735   return attributes
 736 }
 737
 738 function streamingPlaylistActivityUrlToDBAttributes (video: MVideoId, videoObject: VideoObject, videoFiles: MVideoFile[]) {
 739   const playlistUrls = videoObject.url.filter(u => isAPStreamingPlaylistUrlObject(u)) as ActivityPlaylistUrlObject[]
 740   if (playlistUrls.length === 0) return []
 741
 742   const attributes: (FilteredModelAttributes<VideoStreamingPlaylistModel> & { tagAPObject?: ActivityTagObject[] })[] = []
 743   for (const playlistUrlObject of playlistUrls) {
 744     const segmentsSha256UrlObject = playlistUrlObject.tag.find(isAPPlaylistSegmentHashesUrlObject)
 745
 746     let files: unknown[] = playlistUrlObject.tag.filter(u => isAPVideoUrlObject(u)) as ActivityVideoUrlObject[]
 747
 748     // FIXME: backward compatibility introduced in v2.1.0
 749     if (files.length === 0) files = videoFiles
 750
 751     if (!segmentsSha256UrlObject) {
 752       logger.warn('No segment sha256 URL found in AP playlist object.', { playlistUrl: playlistUrlObject })
 753       continue
 754     }
 755
 756     const attribute = {
 757       type: VideoStreamingPlaylistType.HLS,
 758       playlistUrl: playlistUrlObject.href,
 759       segmentsSha256Url: segmentsSha256UrlObject.href,
 760       p2pMediaLoaderInfohashes: VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(playlistUrlObject.href, files),
 761       p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
 762       videoId: video.id,
 763       tagAPObject: playlistUrlObject.tag
 764     }
 765
 766     attributes.push(attribute)
 767   }
 768
 769   return attributes
 770 }
 771
 772 function getThumbnailFromIcons (videoObject: VideoObject) {
 773   let validIcons = videoObject.icon.filter(i => i.width > THUMBNAILS_SIZE.minWidth)
 774   // Fallback if there are not valid icons
 775   if (validIcons.length === 0) validIcons = videoObject.icon
 776
 777   return minBy(validIcons, 'width')
 778 }
 779
 780 function getPreviewFromIcons (videoObject: VideoObject) {
 781   const validIcons = videoObject.icon.filter(i => i.width > PREVIEWS_SIZE.minWidth)
 782
 783   // FIXME: don't put a fallback here for compatibility with PeerTube <2.2
 784
 785   return maxBy(validIcons, 'width')
 786 }