feature: initial syndication feeds support
[oweals/peertube.git] / server / lib / activitypub / videos.ts
1 import * as Bluebird from 'bluebird'
2 import * as magnetUtil from 'magnet-uri'
3 import { join } from 'path'
4 import * as request from 'request'
5 import { ActivityIconObject } from '../../../shared/index'
6 import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
7 import { VideoPrivacy, VideoRateType } from '../../../shared/models/videos'
8 import { isVideoTorrentObjectValid } from '../../helpers/custom-validators/activitypub/videos'
9 import { isVideoFileInfoHashValid } from '../../helpers/custom-validators/videos'
10 import { retryTransactionWrapper } from '../../helpers/database-utils'
11 import { logger } from '../../helpers/logger'
12 import { doRequest, doRequestAndSaveToFile } from '../../helpers/requests'
13 import { ACTIVITY_PUB, CONFIG, REMOTE_SCHEME, sequelizeTypescript, STATIC_PATHS, VIDEO_MIMETYPE_EXT } from '../../initializers'
14 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
15 import { ActorModel } from '../../models/activitypub/actor'
16 import { TagModel } from '../../models/video/tag'
17 import { VideoModel } from '../../models/video/video'
18 import { VideoChannelModel } from '../../models/video/video-channel'
19 import { VideoFileModel } from '../../models/video/video-file'
20 import { VideoShareModel } from '../../models/video/video-share'
21 import { getOrCreateActorAndServerAndModel } from './actor'
22 import { addVideoComments } from './video-comments'
23
24 function fetchRemoteVideoPreview (video: VideoModel, reject: Function) {
25   const host = video.VideoChannel.Account.Actor.Server.host
26   const path = join(STATIC_PATHS.PREVIEWS, video.getPreviewName())
27
28   // We need to provide a callback, if no we could have an uncaught exception
29   return request.get(REMOTE_SCHEME.HTTP + '://' + host + path, err => {
30     if (err) reject(err)
31   })
32 }
33
34 async function fetchRemoteVideoDescription (video: VideoModel) {
35   const host = video.VideoChannel.Account.Actor.Server.host
36   const path = video.getDescriptionPath()
37   const options = {
38     uri: REMOTE_SCHEME.HTTP + '://' + host + path,
39     json: true
40   }
41
42   const { body } = await doRequest(options)
43   return body.description ? body.description : ''
44 }
45
46 function generateThumbnailFromUrl (video: VideoModel, icon: ActivityIconObject) {
47   const thumbnailName = video.getThumbnailName()
48   const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, thumbnailName)
49
50   const options = {
51     method: 'GET',
52     uri: icon.url
53   }
54   return doRequestAndSaveToFile(options, thumbnailPath)
55 }
56
57 async function videoActivityObjectToDBAttributes (videoChannel: VideoChannelModel,
58                                                   videoObject: VideoTorrentObject,
59                                                   to: string[] = []) {
60   const privacy = to.indexOf(ACTIVITY_PUB.PUBLIC) !== -1 ? VideoPrivacy.PUBLIC : VideoPrivacy.UNLISTED
61
62   const duration = videoObject.duration.replace(/[^\d]+/, '')
63   let language = null
64   if (videoObject.language) {
65     language = parseInt(videoObject.language.identifier, 10)
66   }
67
68   let category = null
69   if (videoObject.category) {
70     category = parseInt(videoObject.category.identifier, 10)
71   }
72
73   let licence = null
74   if (videoObject.licence) {
75     licence = parseInt(videoObject.licence.identifier, 10)
76   }
77
78   const description = videoObject.content || null
79   const support = videoObject.support || null
80
81   return {
82     name: videoObject.name,
83     uuid: videoObject.uuid,
84     url: videoObject.id,
85     category,
86     licence,
87     language,
88     description,
89     support,
90     nsfw: videoObject.sensitive,
91     commentsEnabled: videoObject.commentsEnabled,
92     channelId: videoChannel.id,
93     duration: parseInt(duration, 10),
94     createdAt: new Date(videoObject.published),
95     // FIXME: updatedAt does not seems to be considered by Sequelize
96     updatedAt: new Date(videoObject.updated),
97     views: videoObject.views,
98     likes: 0,
99     dislikes: 0,
100     remote: true,
101     privacy
102   }
103 }
104
105 function videoFileActivityUrlToDBAttributes (videoCreated: VideoModel, videoObject: VideoTorrentObject) {
106   const mimeTypes = Object.keys(VIDEO_MIMETYPE_EXT)
107   const fileUrls = videoObject.url.filter(u => {
108     return mimeTypes.indexOf(u.mimeType) !== -1 && u.mimeType.startsWith('video/')
109   })
110
111   if (fileUrls.length === 0) {
112     throw new Error('Cannot find video files for ' + videoCreated.url)
113   }
114
115   const attributes = []
116   for (const fileUrl of fileUrls) {
117     // Fetch associated magnet uri
118     const magnet = videoObject.url.find(u => {
119       return u.mimeType === 'application/x-bittorrent;x-scheme-handler/magnet' && u.width === fileUrl.width
120     })
121
122     if (!magnet) throw new Error('Cannot find associated magnet uri for file ' + fileUrl.href)
123
124     const parsed = magnetUtil.decode(magnet.href)
125     if (!parsed || isVideoFileInfoHashValid(parsed.infoHash) === false) throw new Error('Cannot parse magnet URI ' + magnet.href)
126
127     const attribute = {
128       extname: VIDEO_MIMETYPE_EXT[ fileUrl.mimeType ],
129       infoHash: parsed.infoHash,
130       resolution: fileUrl.width,
131       size: fileUrl.size,
132       videoId: videoCreated.id
133     }
134     attributes.push(attribute)
135   }
136
137   return attributes
138 }
139
140 async function getOrCreateVideo (videoObject: VideoTorrentObject, channelActor: ActorModel) {
141   logger.debug('Adding remote video %s.', videoObject.id)
142
143   return sequelizeTypescript.transaction(async t => {
144     const sequelizeOptions = {
145       transaction: t
146     }
147     const videoFromDatabase = await VideoModel.loadByUUIDOrURLAndPopulateAccount(videoObject.uuid, videoObject.id, t)
148     if (videoFromDatabase) return videoFromDatabase
149
150     const videoData = await videoActivityObjectToDBAttributes(channelActor.VideoChannel, videoObject, videoObject.to)
151     const video = VideoModel.build(videoData)
152
153     // Don't block on request
154     generateThumbnailFromUrl(video, videoObject.icon)
155       .catch(err => logger.warn('Cannot generate thumbnail of %s.', videoObject.id, { err }))
156
157     const videoCreated = await video.save(sequelizeOptions)
158
159     const videoFileAttributes = videoFileActivityUrlToDBAttributes(videoCreated, videoObject)
160     if (videoFileAttributes.length === 0) {
161       throw new Error('Cannot find valid files for video %s ' + videoObject.url)
162     }
163
164     const tasks = videoFileAttributes.map(f => VideoFileModel.create(f, { transaction: t }))
165     await Promise.all(tasks)
166
167     const tags = videoObject.tag.map(t => t.name)
168     const tagInstances = await TagModel.findOrCreateTags(tags, t)
169     await videoCreated.$set('Tags', tagInstances, sequelizeOptions)
170
171     logger.info('Remote video with uuid %s inserted.', videoObject.uuid)
172
173     videoCreated.VideoChannel = channelActor.VideoChannel
174     return videoCreated
175   })
176 }
177
178 async function getOrCreateAccountAndVideoAndChannel (videoObject: VideoTorrentObject | string, actor?: ActorModel) {
179   if (typeof videoObject === 'string') {
180     const videoUrl = videoObject
181
182     const videoFromDatabase = await VideoModel.loadByUrlAndPopulateAccount(videoUrl)
183     if (videoFromDatabase) {
184       return {
185         video: videoFromDatabase,
186         actor: videoFromDatabase.VideoChannel.Account.Actor,
187         channelActor: videoFromDatabase.VideoChannel.Actor
188       }
189     }
190
191     videoObject = await fetchRemoteVideo(videoUrl)
192     if (!videoObject) throw new Error('Cannot fetch remote video with url: ' + videoUrl)
193   }
194
195   if (!actor) {
196     const actorObj = videoObject.attributedTo.find(a => a.type === 'Person')
197     if (!actorObj) throw new Error('Cannot find associated actor to video ' + videoObject.url)
198
199     actor = await getOrCreateActorAndServerAndModel(actorObj.id)
200   }
201
202   const channel = videoObject.attributedTo.find(a => a.type === 'Group')
203   if (!channel) throw new Error('Cannot find associated video channel to video ' + videoObject.url)
204
205   const channelActor = await getOrCreateActorAndServerAndModel(channel.id)
206
207   const options = {
208     arguments: [ videoObject, channelActor ],
209     errorMessage: 'Cannot insert the remote video with many retries.'
210   }
211
212   const video = await retryTransactionWrapper(getOrCreateVideo, options)
213
214   // Process outside the transaction because we could fetch remote data
215   if (videoObject.likes && Array.isArray(videoObject.likes.orderedItems)) {
216     logger.info('Adding likes of video %s.', video.uuid)
217     await createRates(videoObject.likes.orderedItems, video, 'like')
218   }
219
220   if (videoObject.dislikes && Array.isArray(videoObject.dislikes.orderedItems)) {
221     logger.info('Adding dislikes of video %s.', video.uuid)
222     await createRates(videoObject.dislikes.orderedItems, video, 'dislike')
223   }
224
225   if (videoObject.shares && Array.isArray(videoObject.shares.orderedItems)) {
226     logger.info('Adding shares of video %s.', video.uuid)
227     await addVideoShares(video, videoObject.shares.orderedItems)
228   }
229
230   if (videoObject.comments && Array.isArray(videoObject.comments.orderedItems)) {
231     logger.info('Adding comments of video %s.', video.uuid)
232     await addVideoComments(video, videoObject.comments.orderedItems)
233   }
234
235   return { actor, channelActor, video }
236 }
237
238 async function createRates (actorUrls: string[], video: VideoModel, rate: VideoRateType) {
239   let rateCounts = 0
240   const tasks: Bluebird<number>[] = []
241
242   for (const actorUrl of actorUrls) {
243     const actor = await getOrCreateActorAndServerAndModel(actorUrl)
244     const p = AccountVideoRateModel
245       .create({
246         videoId: video.id,
247         accountId: actor.Account.id,
248         type: rate
249       })
250       .then(() => rateCounts += 1)
251
252     tasks.push(p)
253   }
254
255   await Promise.all(tasks)
256
257   logger.info('Adding %d %s to video %s.', rateCounts, rate, video.uuid)
258
259   // This is "likes" and "dislikes"
260   await video.increment(rate + 's', { by: rateCounts })
261
262   return
263 }
264
265 async function addVideoShares (instance: VideoModel, shareUrls: string[]) {
266   for (const shareUrl of shareUrls) {
267     // Fetch url
268     const { body } = await doRequest({
269       uri: shareUrl,
270       json: true,
271       activityPub: true
272     })
273     if (!body || !body.actor) {
274       logger.warn('Cannot add remote share with url: %s, skipping...', shareUrl)
275       continue
276     }
277
278     const actorUrl = body.actor
279     const actor = await getOrCreateActorAndServerAndModel(actorUrl)
280
281     const entry = {
282       actorId: actor.id,
283       videoId: instance.id,
284       url: shareUrl
285     }
286
287     await VideoShareModel.findOrCreate({
288       where: {
289         url: shareUrl
290       },
291       defaults: entry
292     })
293   }
294 }
295
296 export {
297   getOrCreateAccountAndVideoAndChannel,
298   fetchRemoteVideoPreview,
299   fetchRemoteVideoDescription,
300   generateThumbnailFromUrl,
301   videoActivityObjectToDBAttributes,
302   videoFileActivityUrlToDBAttributes,
303   getOrCreateVideo,
304   addVideoShares}
305
306 // ---------------------------------------------------------------------------
307
308 async function fetchRemoteVideo (videoUrl: string): Promise<VideoTorrentObject> {
309   const options = {
310     uri: videoUrl,
311     method: 'GET',
312     json: true,
313     activityPub: true
314   }
315
316   logger.info('Fetching remote video %s.', videoUrl)
317
318   const { body } = await doRequest(options)
319
320   if (isVideoTorrentObjectValid(body) === false) {
321     logger.debug('Remote video JSON is not valid.', { body })
322     return undefined
323   }
324
325   return body
326 }