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