server/models/video/video-format-utils.ts

   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'
   9 import {
  10   getLocalVideoCommentsActivityPubUrl,
  11   getLocalVideoDislikesActivityPubUrl,
  12   getLocalVideoLikesActivityPubUrl,
  13   getLocalVideoSharesActivityPubUrl
  14 } from '../../lib/activitypub/url'
  15 import {
  16   MStreamingPlaylistRedundanciesOpt,
  17   MVideo,
  18   MVideoAP,
  19   MVideoFile,
  20   MVideoFormattable,
  21   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'
  26
  27 export type VideoFormattingJSONOptions = {
  28   completeDescription?: boolean
  29   additionalAttributes: {
  30     state?: boolean
  31     waitTranscoding?: boolean
  32     scheduledUpdate?: boolean
  33     blacklistInfo?: boolean
  34   }
  35 }
  36
  37 function videoModelToFormattedJSON (video: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
  38   const userHistory = isArray(video.UserVideoHistories) ? video.UserVideoHistories[0] : undefined
  39
  40   const videoObject: Video = {
  41     id: video.id,
  42     uuid: video.uuid,
  43     name: video.name,
  44     category: {
  45       id: video.category,
  46       label: VideoModel.getCategoryLabel(video.category)
  47     },
  48     licence: {
  49       id: video.licence,
  50       label: VideoModel.getLicenceLabel(video.licence)
  51     },
  52     language: {
  53       id: video.language,
  54       label: VideoModel.getLanguageLabel(video.language)
  55     },
  56     privacy: {
  57       id: video.privacy,
  58       label: VideoModel.getPrivacyLabel(video.privacy)
  59     },
  60     nsfw: video.nsfw,
  61
  62     description: options && options.completeDescription === true
  63       ? video.description
  64       : video.getTruncatedDescription(),
  65
  66     isLocal: video.isOwned(),
  67     duration: video.duration,
  68     views: video.views,
  69     likes: video.likes,
  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,
  78
  79     isLive: video.isLive,
  80
  81     account: video.VideoChannel.Account.toFormattedSummaryJSON(),
  82     channel: video.VideoChannel.toFormattedSummaryJSON(),
  83
  84     userHistory: userHistory
  85       ? { currentTime: userHistory.currentTime }
  86       : undefined,
  87
  88     // Can be added by external plugins
  89     pluginData: (video as any).pluginData
  90   }
  91
  92   if (options) {
  93     if (options.additionalAttributes.state === true) {
  94       videoObject.state = {
  95         id: video.state,
  96         label: VideoModel.getStateLabel(video.state)
  97       }
  98     }
  99
 100     if (options.additionalAttributes.waitTranscoding === true) {
 101       videoObject.waitTranscoding = video.waitTranscoding
 102     }
 103
 104     if (options.additionalAttributes.scheduledUpdate === true && video.ScheduleVideoUpdate) {
 105       videoObject.scheduledUpdate = {
 106         updateAt: video.ScheduleVideoUpdate.updateAt,
 107         privacy: video.ScheduleVideoUpdate.privacy || undefined
 108       }
 109     }
 110
 111     if (options.additionalAttributes.blacklistInfo === true) {
 112       videoObject.blacklisted = !!video.VideoBlacklist
 113       videoObject.blacklistedReason = video.VideoBlacklist ? video.VideoBlacklist.reason : null
 114     }
 115   }
 116
 117   return videoObject
 118 }
 119
 120 function videoModelToFormattedDetailsJSON (video: MVideoFormattableDetails): VideoDetails {
 121   const formattedJson = video.toFormattedJSON({
 122     additionalAttributes: {
 123       scheduledUpdate: true,
 124       blacklistInfo: true
 125     }
 126   })
 127
 128   const tags = video.Tags ? video.Tags.map(t => t.name) : []
 129
 130   const streamingPlaylists = streamingPlaylistsModelToFormattedJSON(video, video.VideoStreamingPlaylists)
 131
 132   const detailsJson = {
 133     support: video.support,
 134     descriptionPath: video.getDescriptionAPIPath(),
 135     channel: video.VideoChannel.toFormattedJSON(),
 136     account: video.VideoChannel.Account.toFormattedJSON(),
 137     tags,
 138     commentsEnabled: video.commentsEnabled,
 139     downloadEnabled: video.downloadEnabled,
 140     waitTranscoding: video.waitTranscoding,
 141     state: {
 142       id: video.state,
 143       label: VideoModel.getStateLabel(video.state)
 144     },
 145
 146     trackerUrls: video.getTrackerUrls(),
 147
 148     files: [],
 149     streamingPlaylists
 150   }
 151
 152   // Format and sort video files
 153   detailsJson.files = videoFilesModelToFormattedJSON(video, video.VideoFiles)
 154
 155   return Object.assign(formattedJson, detailsJson)
 156 }
 157
 158 function streamingPlaylistsModelToFormattedJSON (
 159   video: MVideoFormattableDetails,
 160   playlists: MStreamingPlaylistRedundanciesOpt[]
 161 ): VideoStreamingPlaylist[] {
 162   if (isArray(playlists) === false) return []
 163
 164   return playlists
 165     .map(playlist => {
 166       const redundancies = isArray(playlist.RedundancyVideos)
 167         ? playlist.RedundancyVideos.map(r => ({ baseUrl: r.fileUrl }))
 168         : []
 169
 170       const files = videoFilesModelToFormattedJSON(video, playlist.VideoFiles)
 171
 172       return {
 173         id: playlist.id,
 174         type: playlist.type,
 175         playlistUrl: playlist.playlistUrl,
 176         segmentsSha256Url: playlist.segmentsSha256Url,
 177         redundancies,
 178         files
 179       }
 180     })
 181 }
 182
 183 function sortByResolutionDesc (fileA: MVideoFile, fileB: MVideoFile) {
 184   if (fileA.resolution < fileB.resolution) return 1
 185   if (fileA.resolution === fileB.resolution) return 0
 186   return -1
 187 }
 188
 189 function videoFilesModelToFormattedJSON (
 190   video: MVideoFormattableDetails,
 191   videoFiles: MVideoFileRedundanciesOpt[],
 192   includeMagnet = true
 193 ): VideoFile[] {
 194   const trackerUrls = includeMagnet
 195     ? video.getTrackerUrls()
 196     : []
 197
 198   return [ ...videoFiles ]
 199     .filter(f => !f.isLive())
 200     .sort(sortByResolutionDesc)
 201     .map(videoFile => {
 202       return {
 203         resolution: {
 204           id: videoFile.resolution,
 205           label: videoFile.resolution + 'p'
 206         },
 207
 208         magnetUri: includeMagnet && videoFile.torrentFilename
 209           ? generateMagnetUri(video, videoFile, trackerUrls)
 210           : undefined,
 211
 212         size: videoFile.size,
 213         fps: videoFile.fps,
 214
 215         torrentUrl: videoFile.getTorrentUrl(),
 216         torrentDownloadUrl: videoFile.getTorrentDownloadUrl(),
 217
 218         fileUrl: videoFile.getFileUrl(video),
 219         fileDownloadUrl: videoFile.getFileDownloadUrl(video),
 220
 221         metadataUrl: videoFile.metadataUrl ?? getLocalVideoFileMetadataUrl(video, videoFile)
 222       } as VideoFile
 223     })
 224 }
 225
 226 function addVideoFilesInAPAcc (
 227   acc: ActivityUrlObject[] | ActivityTagObject[],
 228   video: MVideo,
 229   files: MVideoFile[]
 230 ) {
 231   const trackerUrls = video.getTrackerUrls()
 232
 233   const sortedFiles = [ ...files ]
 234     .filter(f => !f.isLive())
 235     .sort(sortByResolutionDesc)
 236
 237   for (const file of sortedFiles) {
 238     acc.push({
 239       type: 'Link',
 240       mediaType: MIMETYPES.VIDEO.EXT_MIMETYPE[file.extname] as any,
 241       href: file.getFileUrl(video),
 242       height: file.resolution,
 243       size: file.size,
 244       fps: file.fps
 245     })
 246
 247     acc.push({
 248       type: 'Link',
 249       rel: [ 'metadata', MIMETYPES.VIDEO.EXT_MIMETYPE[file.extname] ],
 250       mediaType: 'application/json' as 'application/json',
 251       href: getLocalVideoFileMetadataUrl(video, file),
 252       height: file.resolution,
 253       fps: file.fps
 254     })
 255
 256     acc.push({
 257       type: 'Link',
 258       mediaType: 'application/x-bittorrent' as 'application/x-bittorrent',
 259       href: file.getTorrentUrl(),
 260       height: file.resolution
 261     })
 262
 263     acc.push({
 264       type: 'Link',
 265       mediaType: 'application/x-bittorrent;x-scheme-handler/magnet' as 'application/x-bittorrent;x-scheme-handler/magnet',
 266       href: generateMagnetUri(video, file, trackerUrls),
 267       height: file.resolution
 268     })
 269   }
 270 }
 271
 272 function videoModelToActivityPubObject (video: MVideoAP): VideoObject {
 273   if (!video.Tags) video.Tags = []
 274
 275   const tag = video.Tags.map(t => ({
 276     type: 'Hashtag' as 'Hashtag',
 277     name: t.name
 278   }))
 279
 280   let language
 281   if (video.language) {
 282     language = {
 283       identifier: video.language,
 284       name: VideoModel.getLanguageLabel(video.language)
 285     }
 286   }
 287
 288   let category
 289   if (video.category) {
 290     category = {
 291       identifier: video.category + '',
 292       name: VideoModel.getCategoryLabel(video.category)
 293     }
 294   }
 295
 296   let licence
 297   if (video.licence) {
 298     licence = {
 299       identifier: video.licence + '',
 300       name: VideoModel.getLicenceLabel(video.licence)
 301     }
 302   }
 303
 304   const url: ActivityUrlObject[] = [
 305     // HTML url should be the first element in the array so Mastodon correctly displays the embed
 306     {
 307       type: 'Link',
 308       mediaType: 'text/html',
 309       href: WEBSERVER.URL + '/videos/watch/' + video.uuid
 310     }
 311   ]
 312
 313   addVideoFilesInAPAcc(url, video, video.VideoFiles || [])
 314
 315   for (const playlist of (video.VideoStreamingPlaylists || [])) {
 316     const tag = playlist.p2pMediaLoaderInfohashes
 317                   .map(i => ({ type: 'Infohash' as 'Infohash', name: i })) as ActivityTagObject[]
 318     tag.push({
 319       type: 'Link',
 320       name: 'sha256',
 321       mediaType: 'application/json' as 'application/json',
 322       href: playlist.segmentsSha256Url
 323     })
 324
 325     addVideoFilesInAPAcc(tag, video, playlist.VideoFiles || [])
 326
 327     url.push({
 328       type: 'Link',
 329       mediaType: 'application/x-mpegURL' as 'application/x-mpegURL',
 330       href: playlist.playlistUrl,
 331       tag
 332     })
 333   }
 334
 335   for (const trackerUrl of video.getTrackerUrls()) {
 336     const rel2 = trackerUrl.startsWith('http')
 337       ? 'http'
 338       : 'websocket'
 339
 340     url.push({
 341       type: 'Link',
 342       name: `tracker-${rel2}`,
 343       rel: [ 'tracker', rel2 ],
 344       href: trackerUrl
 345     })
 346   }
 347
 348   const subtitleLanguage = []
 349   for (const caption of video.VideoCaptions) {
 350     subtitleLanguage.push({
 351       identifier: caption.language,
 352       name: VideoCaptionModel.getLanguageLabel(caption.language),
 353       url: caption.getFileUrl(video)
 354     })
 355   }
 356
 357   const icons = [ video.getMiniature(), video.getPreview() ]
 358
 359   return {
 360     type: 'Video' as 'Video',
 361     id: video.url,
 362     name: video.name,
 363     duration: getActivityStreamDuration(video.duration),
 364     uuid: video.uuid,
 365     tag,
 366     category,
 367     licence,
 368     language,
 369     views: video.views,
 370     sensitive: video.nsfw,
 371     waitTranscoding: video.waitTranscoding,
 372     isLiveBroadcast: video.isLive,
 373
 374     liveSaveReplay: video.isLive
 375       ? video.VideoLive.saveReplay
 376       : null,
 377
 378     permanentLive: video.isLive
 379       ? video.VideoLive.permanentLive
 380       : null,
 381
 382     state: video.state,
 383     commentsEnabled: video.commentsEnabled,
 384     downloadEnabled: video.downloadEnabled,
 385     published: video.publishedAt.toISOString(),
 386
 387     originallyPublishedAt: video.originallyPublishedAt
 388       ? video.originallyPublishedAt.toISOString()
 389       : null,
 390
 391     updated: video.updatedAt.toISOString(),
 392     mediaType: 'text/markdown',
 393     content: video.description,
 394     support: video.support,
 395     subtitleLanguage,
 396     icon: icons.map(i => ({
 397       type: 'Image',
 398       url: i.getFileUrl(video),
 399       mediaType: 'image/jpeg',
 400       width: i.width,
 401       height: i.height
 402     })),
 403     url,
 404     likes: getLocalVideoLikesActivityPubUrl(video),
 405     dislikes: getLocalVideoDislikesActivityPubUrl(video),
 406     shares: getLocalVideoSharesActivityPubUrl(video),
 407     comments: getLocalVideoCommentsActivityPubUrl(video),
 408     attributedTo: [
 409       {
 410         type: 'Person',
 411         id: video.VideoChannel.Account.Actor.url
 412       },
 413       {
 414         type: 'Group',
 415         id: video.VideoChannel.Actor.url
 416       }
 417     ]
 418   }
 419 }
 420
 421 function getActivityStreamDuration (duration: number) {
 422   // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
 423   return 'PT' + duration + 'S'
 424 }
 425
 426 export {
 427   videoModelToFormattedJSON,
 428   videoModelToFormattedDetailsJSON,
 429   videoFilesModelToFormattedJSON,
 430   videoModelToActivityPubObject,
 431   getActivityStreamDuration
 432 }