1 import { PlaylistObject } from '../../../shared/models/activitypub/objects/playlist-object'
2 import { crawlCollectionPage } from './crawl'
3 import { ACTIVITY_PUB, CONFIG, CRAWL_REQUEST_CONCURRENCY, sequelizeTypescript, THUMBNAILS_SIZE } from '../../initializers'
4 import { AccountModel } from '../../models/account/account'
5 import { isArray } from '../../helpers/custom-validators/misc'
6 import { getOrCreateActorAndServerAndModel } from './actor'
7 import { logger } from '../../helpers/logger'
8 import { VideoPlaylistModel } from '../../models/video/video-playlist'
9 import { doRequest, downloadImage } from '../../helpers/requests'
10 import { checkUrlsSameHost } from '../../helpers/activitypub'
11 import * as Bluebird from 'bluebird'
12 import { PlaylistElementObject } from '../../../shared/models/activitypub/objects/playlist-element-object'
13 import { getOrCreateVideoAndAccountAndChannel } from './videos'
14 import { isPlaylistElementObjectValid, isPlaylistObjectValid } from '../../helpers/custom-validators/activitypub/playlist'
15 import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element'
16 import { VideoModel } from '../../models/video/video'
17 import { FilteredModelAttributes } from 'sequelize-typescript/lib/models/Model'
18 import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model'
19 import { ActivityIconObject } from '../../../shared/models/activitypub/objects'
21 function playlistObjectToDBAttributes (playlistObject: PlaylistObject, byAccount: AccountModel, to: string[]) {
22 const privacy = to.indexOf(ACTIVITY_PUB.PUBLIC) !== -1 ? VideoPlaylistPrivacy.PUBLIC : VideoPlaylistPrivacy.UNLISTED
25 name: playlistObject.name,
26 description: playlistObject.content,
28 url: playlistObject.id,
29 uuid: playlistObject.uuid,
30 ownerAccountId: byAccount.id,
32 createdAt: new Date(playlistObject.published),
33 updatedAt: new Date(playlistObject.updated)
37 function playlistElementObjectToDBAttributes (elementObject: PlaylistElementObject, videoPlaylist: VideoPlaylistModel, video: VideoModel) {
39 position: elementObject.position,
40 url: elementObject.id,
41 startTimestamp: elementObject.startTimestamp || null,
42 stopTimestamp: elementObject.stopTimestamp || null,
43 videoPlaylistId: videoPlaylist.id,
48 async function createAccountPlaylists (playlistUrls: string[], account: AccountModel) {
49 await Bluebird.map(playlistUrls, async playlistUrl => {
51 const exists = await VideoPlaylistModel.doesPlaylistExist(playlistUrl)
52 if (exists === true) return
55 const { body } = await doRequest<PlaylistObject>({
61 if (!isPlaylistObjectValid(body)) {
62 throw new Error(`Invalid playlist object when fetch account playlists: ${JSON.stringify(body)}`)
65 if (!isArray(body.to)) {
66 throw new Error('Playlist does not have an audience.')
69 return createOrUpdateVideoPlaylist(body, account, body.to)
71 logger.warn('Cannot add playlist element %s.', playlistUrl, { err })
73 }, { concurrency: CRAWL_REQUEST_CONCURRENCY })
76 async function createOrUpdateVideoPlaylist (playlistObject: PlaylistObject, byAccount: AccountModel, to: string[]) {
77 const playlistAttributes = playlistObjectToDBAttributes(playlistObject, byAccount, to)
79 if (isArray(playlistObject.attributedTo) && playlistObject.attributedTo.length === 1) {
80 const actor = await getOrCreateActorAndServerAndModel(playlistObject.attributedTo[0])
82 if (actor.VideoChannel) {
83 playlistAttributes.videoChannelId = actor.VideoChannel.id
85 logger.warn('Attributed to of video playlist %s is not a video channel.', playlistObject.id, { playlistObject })
89 const [ playlist ] = await VideoPlaylistModel.upsert<VideoPlaylistModel>(playlistAttributes, { returning: true })
91 let accItems: string[] = []
92 await crawlCollectionPage<string>(playlistObject.id, items => {
93 accItems = accItems.concat(items)
95 return Promise.resolve()
98 // Empty playlists generally do not have a miniature, so skip this
99 if (accItems.length !== 0) {
101 await generateThumbnailFromUrl(playlist, playlistObject.icon)
103 logger.warn('Cannot generate thumbnail of %s.', playlistObject.id, { err })
107 return resetVideoPlaylistElements(accItems, playlist)
110 async function refreshVideoPlaylistIfNeeded (videoPlaylist: VideoPlaylistModel): Promise<VideoPlaylistModel> {
111 if (!videoPlaylist.isOutdated()) return videoPlaylist
114 const { statusCode, playlistObject } = await fetchRemoteVideoPlaylist(videoPlaylist.url)
115 if (statusCode === 404) {
116 logger.info('Cannot refresh remote video playlist %s: it does not exist anymore. Deleting it.', videoPlaylist.url)
118 await videoPlaylist.destroy()
122 if (playlistObject === undefined) {
123 logger.warn('Cannot refresh remote playlist %s: invalid body.', videoPlaylist.url)
125 await videoPlaylist.setAsRefreshed()
129 const byAccount = videoPlaylist.OwnerAccount
130 await createOrUpdateVideoPlaylist(playlistObject, byAccount, playlistObject.to)
134 logger.warn('Cannot refresh video playlist %s.', videoPlaylist.url, { err })
136 await videoPlaylist.setAsRefreshed()
141 // ---------------------------------------------------------------------------
144 createAccountPlaylists,
145 playlistObjectToDBAttributes,
146 playlistElementObjectToDBAttributes,
147 createOrUpdateVideoPlaylist,
148 refreshVideoPlaylistIfNeeded
151 // ---------------------------------------------------------------------------
153 async function resetVideoPlaylistElements (elementUrls: string[], playlist: VideoPlaylistModel) {
154 const elementsToCreate: FilteredModelAttributes<VideoPlaylistElementModel>[] = []
156 await Bluebird.map(elementUrls, async elementUrl => {
159 const { body } = await doRequest<PlaylistElementObject>({
165 if (!isPlaylistElementObjectValid(body)) throw new Error(`Invalid body in video get playlist element ${elementUrl}`)
167 if (checkUrlsSameHost(body.id, elementUrl) !== true) {
168 throw new Error(`Playlist element url ${elementUrl} host is different from the AP object id ${body.id}`)
171 const { video } = await getOrCreateVideoAndAccountAndChannel({ videoObject: { id: body.url }, fetchType: 'only-video' })
173 elementsToCreate.push(playlistElementObjectToDBAttributes(body, playlist, video))
175 logger.warn('Cannot add playlist element %s.', elementUrl, { err })
177 }, { concurrency: CRAWL_REQUEST_CONCURRENCY })
179 await sequelizeTypescript.transaction(async t => {
180 await VideoPlaylistElementModel.deleteAllOf(playlist.id, t)
182 for (const element of elementsToCreate) {
183 await VideoPlaylistElementModel.create(element, { transaction: t })
187 logger.info('Reset playlist %s with %s elements.', playlist.url, elementsToCreate.length)
192 function generateThumbnailFromUrl (playlist: VideoPlaylistModel, icon: ActivityIconObject) {
193 const thumbnailName = playlist.getThumbnailName()
195 return downloadImage(icon.url, CONFIG.STORAGE.THUMBNAILS_DIR, thumbnailName, THUMBNAILS_SIZE)
198 async function fetchRemoteVideoPlaylist (playlistUrl: string): Promise<{ statusCode: number, playlistObject: PlaylistObject }> {
206 logger.info('Fetching remote playlist %s.', playlistUrl)
208 const { response, body } = await doRequest(options)
210 if (isPlaylistObjectValid(body) === false || checkUrlsSameHost(body.id, playlistUrl) !== true) {
211 logger.debug('Remote video playlist JSON is not valid.', { body })
212 return { statusCode: response.statusCode, playlistObject: undefined }
215 return { statusCode: response.statusCode, playlistObject: body }