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