1 import { generateMagnetUri } from '@server/helpers/webtorrent'
2 import { getLocalVideoFileMetadataUrl } from '@server/lib/video-paths'
3 import { VideoFile } from '@shared/models/videos/video-file.model'
4 import { ActivityTagObject, ActivityUrlObject, VideoObject } from '../../../shared/models/activitypub/objects'
5 import { Video, VideoDetails } from '../../../shared/models/videos'
6 import { VideoStreamingPlaylist } from '../../../shared/models/videos/video-streaming-playlist.model'
7 import { isArray } from '../../helpers/custom-validators/misc'
8 import { MIMETYPES, WEBSERVER } from '../../initializers/constants'
10 getLocalVideoCommentsActivityPubUrl,
11 getLocalVideoDislikesActivityPubUrl,
12 getLocalVideoLikesActivityPubUrl,
13 getLocalVideoSharesActivityPubUrl
14 } from '../../lib/activitypub/url'
16 MStreamingPlaylistRedundanciesOpt,
20 MVideoFormattableDetails,
22 } from '../../types/models'
23 import { MVideoFileRedundanciesOpt } from '../../types/models/video/video-file'
24 import { VideoModel } from './video'
25 import { VideoCaptionModel } from './video-caption'
27 export type VideoFormattingJSONOptions = {
28 completeDescription?: boolean
29 additionalAttributes: {
31 waitTranscoding?: boolean
32 scheduledUpdate?: boolean
33 blacklistInfo?: boolean
37 function videoModelToFormattedJSON (video: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
38 const userHistory = isArray(video.UserVideoHistories) ? video.UserVideoHistories[0] : undefined
40 const videoObject: Video = {
46 label: VideoModel.getCategoryLabel(video.category)
50 label: VideoModel.getLicenceLabel(video.licence)
54 label: VideoModel.getLanguageLabel(video.language)
58 label: VideoModel.getPrivacyLabel(video.privacy)
62 description: options && options.completeDescription === true
64 : video.getTruncatedDescription(),
66 isLocal: video.isOwned(),
67 duration: video.duration,
70 dislikes: video.dislikes,
71 thumbnailPath: video.getMiniatureStaticPath(),
72 previewPath: video.getPreviewStaticPath(),
73 embedPath: video.getEmbedStaticPath(),
74 createdAt: video.createdAt,
75 updatedAt: video.updatedAt,
76 publishedAt: video.publishedAt,
77 originallyPublishedAt: video.originallyPublishedAt,
81 account: video.VideoChannel.Account.toFormattedSummaryJSON(),
82 channel: video.VideoChannel.toFormattedSummaryJSON(),
84 userHistory: userHistory
85 ? { currentTime: userHistory.currentTime }
88 // Can be added by external plugins
89 pluginData: (video as any).pluginData
93 if (options.additionalAttributes.state === true) {
96 label: VideoModel.getStateLabel(video.state)
100 if (options.additionalAttributes.waitTranscoding === true) {
101 videoObject.waitTranscoding = video.waitTranscoding
104 if (options.additionalAttributes.scheduledUpdate === true && video.ScheduleVideoUpdate) {
105 videoObject.scheduledUpdate = {
106 updateAt: video.ScheduleVideoUpdate.updateAt,
107 privacy: video.ScheduleVideoUpdate.privacy || undefined
111 if (options.additionalAttributes.blacklistInfo === true) {
112 videoObject.blacklisted = !!video.VideoBlacklist
113 videoObject.blacklistedReason = video.VideoBlacklist ? video.VideoBlacklist.reason : null
120 function videoModelToFormattedDetailsJSON (video: MVideoFormattableDetails): VideoDetails {
121 const formattedJson = video.toFormattedJSON({
122 additionalAttributes: {
123 scheduledUpdate: true,
128 const tags = video.Tags ? video.Tags.map(t => t.name) : []
130 const streamingPlaylists = streamingPlaylistsModelToFormattedJSON(video, video.VideoStreamingPlaylists)
132 const detailsJson = {
133 support: video.support,
134 descriptionPath: video.getDescriptionAPIPath(),
135 channel: video.VideoChannel.toFormattedJSON(),
136 account: video.VideoChannel.Account.toFormattedJSON(),
138 commentsEnabled: video.commentsEnabled,
139 downloadEnabled: video.downloadEnabled,
140 waitTranscoding: video.waitTranscoding,
143 label: VideoModel.getStateLabel(video.state)
146 trackerUrls: video.getTrackerUrls(),
152 // Format and sort video files
153 detailsJson.files = videoFilesModelToFormattedJSON(video, video.VideoFiles)
155 return Object.assign(formattedJson, detailsJson)
158 function streamingPlaylistsModelToFormattedJSON (
159 video: MVideoFormattableDetails,
160 playlists: MStreamingPlaylistRedundanciesOpt[]
161 ): VideoStreamingPlaylist[] {
162 if (isArray(playlists) === false) return []
166 const redundancies = isArray(playlist.RedundancyVideos)
167 ? playlist.RedundancyVideos.map(r => ({ baseUrl: r.fileUrl }))
170 const files = videoFilesModelToFormattedJSON(video, playlist.VideoFiles)
175 playlistUrl: playlist.playlistUrl,
176 segmentsSha256Url: playlist.segmentsSha256Url,
183 function sortByResolutionDesc (fileA: MVideoFile, fileB: MVideoFile) {
184 if (fileA.resolution < fileB.resolution) return 1
185 if (fileA.resolution === fileB.resolution) return 0
189 function videoFilesModelToFormattedJSON (
190 video: MVideoFormattableDetails,
191 videoFiles: MVideoFileRedundanciesOpt[]
193 const trackerUrls = video.getTrackerUrls()
195 return [ ...videoFiles ]
196 .filter(f => !f.isLive())
197 .sort(sortByResolutionDesc)
201 id: videoFile.resolution,
202 label: videoFile.resolution + 'p'
205 // FIXME: deprecated in 3.2
206 magnetUri: generateMagnetUri(video, videoFile, trackerUrls),
208 size: videoFile.size,
211 torrentUrl: videoFile.getTorrentUrl(),
212 torrentDownloadUrl: videoFile.getTorrentDownloadUrl(),
214 fileUrl: videoFile.getFileUrl(video),
215 fileDownloadUrl: videoFile.getFileDownloadUrl(video),
217 metadataUrl: videoFile.metadataUrl ?? getLocalVideoFileMetadataUrl(video, videoFile)
222 function addVideoFilesInAPAcc (
223 acc: ActivityUrlObject[] | ActivityTagObject[],
224 video: MVideoWithHost,
227 const trackerUrls = video.getTrackerUrls()
229 const sortedFiles = [ ...files ]
230 .filter(f => !f.isLive())
231 .sort(sortByResolutionDesc)
233 for (const file of sortedFiles) {
236 mediaType: MIMETYPES.VIDEO.EXT_MIMETYPE[file.extname] as any,
237 href: file.getFileUrl(video),
238 height: file.resolution,
245 rel: [ 'metadata', MIMETYPES.VIDEO.EXT_MIMETYPE[file.extname] ],
246 mediaType: 'application/json' as 'application/json',
247 href: getLocalVideoFileMetadataUrl(video, file),
248 height: file.resolution,
254 mediaType: 'application/x-bittorrent' as 'application/x-bittorrent',
255 href: file.getTorrentUrl(),
256 height: file.resolution
261 mediaType: 'application/x-bittorrent;x-scheme-handler/magnet' as 'application/x-bittorrent;x-scheme-handler/magnet',
262 href: generateMagnetUri(video, file, trackerUrls),
263 height: file.resolution
268 function videoModelToActivityPubObject (video: MVideoAP): VideoObject {
269 if (!video.Tags) video.Tags = []
271 const tag = video.Tags.map(t => ({
272 type: 'Hashtag' as 'Hashtag',
277 if (video.language) {
279 identifier: video.language,
280 name: VideoModel.getLanguageLabel(video.language)
285 if (video.category) {
287 identifier: video.category + '',
288 name: VideoModel.getCategoryLabel(video.category)
295 identifier: video.licence + '',
296 name: VideoModel.getLicenceLabel(video.licence)
300 const url: ActivityUrlObject[] = [
301 // HTML url should be the first element in the array so Mastodon correctly displays the embed
304 mediaType: 'text/html',
305 href: WEBSERVER.URL + '/videos/watch/' + video.uuid
309 addVideoFilesInAPAcc(url, video, video.VideoFiles || [])
311 for (const playlist of (video.VideoStreamingPlaylists || [])) {
312 const tag = playlist.p2pMediaLoaderInfohashes
313 .map(i => ({ type: 'Infohash' as 'Infohash', name: i })) as ActivityTagObject[]
317 mediaType: 'application/json' as 'application/json',
318 href: playlist.segmentsSha256Url
321 addVideoFilesInAPAcc(tag, video, playlist.VideoFiles || [])
325 mediaType: 'application/x-mpegURL' as 'application/x-mpegURL',
326 href: playlist.playlistUrl,
331 for (const trackerUrl of video.getTrackerUrls()) {
332 const rel2 = trackerUrl.startsWith('http')
338 name: `tracker-${rel2}`,
339 rel: [ 'tracker', rel2 ],
344 const subtitleLanguage = []
345 for (const caption of video.VideoCaptions) {
346 subtitleLanguage.push({
347 identifier: caption.language,
348 name: VideoCaptionModel.getLanguageLabel(caption.language),
349 url: caption.getFileUrl(video)
353 const icons = [ video.getMiniature(), video.getPreview() ]
356 type: 'Video' as 'Video',
359 duration: getActivityStreamDuration(video.duration),
366 sensitive: video.nsfw,
367 waitTranscoding: video.waitTranscoding,
368 isLiveBroadcast: video.isLive,
370 liveSaveReplay: video.isLive
371 ? video.VideoLive.saveReplay
374 permanentLive: video.isLive
375 ? video.VideoLive.permanentLive
379 commentsEnabled: video.commentsEnabled,
380 downloadEnabled: video.downloadEnabled,
381 published: video.publishedAt.toISOString(),
383 originallyPublishedAt: video.originallyPublishedAt
384 ? video.originallyPublishedAt.toISOString()
387 updated: video.updatedAt.toISOString(),
388 mediaType: 'text/markdown',
389 content: video.description,
390 support: video.support,
392 icon: icons.map(i => ({
394 url: i.getFileUrl(video),
395 mediaType: 'image/jpeg',
400 likes: getLocalVideoLikesActivityPubUrl(video),
401 dislikes: getLocalVideoDislikesActivityPubUrl(video),
402 shares: getLocalVideoSharesActivityPubUrl(video),
403 comments: getLocalVideoCommentsActivityPubUrl(video),
407 id: video.VideoChannel.Account.Actor.url
411 id: video.VideoChannel.Actor.url
417 function getActivityStreamDuration (duration: number) {
418 // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
419 return 'PT' + duration + 'S'
423 videoModelToFormattedJSON,
424 videoModelToFormattedDetailsJSON,
425 videoFilesModelToFormattedJSON,
426 videoModelToActivityPubObject,
427 getActivityStreamDuration