]>
Commit | Line | Data |
---|---|---|
418d092a C |
1 | import * as express from 'express' |
2 | import { getFormattedObjects, getServerActor } from '../../helpers/utils' | |
3 | import { | |
4 | asyncMiddleware, | |
5 | asyncRetryTransactionMiddleware, | |
6 | authenticate, | |
09979f89 C |
7 | commonVideosFiltersValidator, |
8 | optionalAuthenticate, | |
418d092a C |
9 | paginationValidator, |
10 | setDefaultPagination, | |
11 | setDefaultSort | |
12 | } from '../../middlewares' | |
418d092a C |
13 | import { videoPlaylistsSortValidator } from '../../middlewares/validators' |
14 | import { buildNSFWFilter, createReqFiles, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils' | |
e8bafea3 | 15 | import { MIMETYPES, VIDEO_PLAYLIST_PRIVACIES } from '../../initializers/constants' |
418d092a C |
16 | import { logger } from '../../helpers/logger' |
17 | import { resetSequelizeInstance } from '../../helpers/database-utils' | |
18 | import { VideoPlaylistModel } from '../../models/video/video-playlist' | |
19 | import { | |
df0b219d | 20 | commonVideoPlaylistFiltersValidator, |
418d092a C |
21 | videoPlaylistsAddValidator, |
22 | videoPlaylistsAddVideoValidator, | |
23 | videoPlaylistsDeleteValidator, | |
24 | videoPlaylistsGetValidator, | |
25 | videoPlaylistsReorderVideosValidator, | |
26 | videoPlaylistsUpdateOrRemoveVideoValidator, | |
27 | videoPlaylistsUpdateValidator | |
28 | } from '../../middlewares/validators/videos/video-playlists' | |
29 | import { VideoPlaylistCreate } from '../../../shared/models/videos/playlist/video-playlist-create.model' | |
30 | import { VideoPlaylistPrivacy } from '../../../shared/models/videos/playlist/video-playlist-privacy.model' | |
418d092a | 31 | import { join } from 'path' |
09979f89 C |
32 | import { sendCreateVideoPlaylist, sendDeleteVideoPlaylist, sendUpdateVideoPlaylist } from '../../lib/activitypub/send' |
33 | import { getVideoPlaylistActivityPubUrl, getVideoPlaylistElementActivityPubUrl } from '../../lib/activitypub/url' | |
418d092a C |
34 | import { VideoPlaylistUpdate } from '../../../shared/models/videos/playlist/video-playlist-update.model' |
35 | import { VideoModel } from '../../models/video/video' | |
36 | import { VideoPlaylistElementModel } from '../../models/video/video-playlist-element' | |
37 | import { VideoPlaylistElementCreate } from '../../../shared/models/videos/playlist/video-playlist-element-create.model' | |
38 | import { VideoPlaylistElementUpdate } from '../../../shared/models/videos/playlist/video-playlist-element-update.model' | |
df0b219d | 39 | import { AccountModel } from '../../models/account/account' |
15e9d5ca | 40 | import { VideoPlaylistReorder } from '../../../shared/models/videos/playlist/video-playlist-reorder.model' |
9f79ade6 | 41 | import { JobQueue } from '../../lib/job-queue' |
6dd9de95 | 42 | import { CONFIG } from '../../initializers/config' |
74dc3bca | 43 | import { sequelizeTypescript } from '../../initializers/database' |
3acc5084 | 44 | import { createPlaylistMiniatureFromExisting } from '../../lib/thumbnail' |
418d092a C |
45 | |
46 | const reqThumbnailFile = createReqFiles([ 'thumbnailfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { thumbnailfile: CONFIG.STORAGE.TMP_DIR }) | |
47 | ||
48 | const videoPlaylistRouter = express.Router() | |
49 | ||
d4c9f45b C |
50 | videoPlaylistRouter.get('/privacies', listVideoPlaylistPrivacies) |
51 | ||
418d092a C |
52 | videoPlaylistRouter.get('/', |
53 | paginationValidator, | |
54 | videoPlaylistsSortValidator, | |
55 | setDefaultSort, | |
56 | setDefaultPagination, | |
df0b219d | 57 | commonVideoPlaylistFiltersValidator, |
418d092a C |
58 | asyncMiddleware(listVideoPlaylists) |
59 | ) | |
60 | ||
61 | videoPlaylistRouter.get('/:playlistId', | |
62 | asyncMiddleware(videoPlaylistsGetValidator), | |
63 | getVideoPlaylist | |
64 | ) | |
65 | ||
66 | videoPlaylistRouter.post('/', | |
67 | authenticate, | |
68 | reqThumbnailFile, | |
69 | asyncMiddleware(videoPlaylistsAddValidator), | |
70 | asyncRetryTransactionMiddleware(addVideoPlaylist) | |
71 | ) | |
72 | ||
73 | videoPlaylistRouter.put('/:playlistId', | |
74 | authenticate, | |
75 | reqThumbnailFile, | |
76 | asyncMiddleware(videoPlaylistsUpdateValidator), | |
77 | asyncRetryTransactionMiddleware(updateVideoPlaylist) | |
78 | ) | |
79 | ||
80 | videoPlaylistRouter.delete('/:playlistId', | |
81 | authenticate, | |
82 | asyncMiddleware(videoPlaylistsDeleteValidator), | |
83 | asyncRetryTransactionMiddleware(removeVideoPlaylist) | |
84 | ) | |
85 | ||
86 | videoPlaylistRouter.get('/:playlistId/videos', | |
87 | asyncMiddleware(videoPlaylistsGetValidator), | |
88 | paginationValidator, | |
89 | setDefaultPagination, | |
07b1a18a | 90 | optionalAuthenticate, |
418d092a C |
91 | commonVideosFiltersValidator, |
92 | asyncMiddleware(getVideoPlaylistVideos) | |
93 | ) | |
94 | ||
95 | videoPlaylistRouter.post('/:playlistId/videos', | |
96 | authenticate, | |
97 | asyncMiddleware(videoPlaylistsAddVideoValidator), | |
98 | asyncRetryTransactionMiddleware(addVideoInPlaylist) | |
99 | ) | |
100 | ||
07b1a18a | 101 | videoPlaylistRouter.post('/:playlistId/videos/reorder', |
418d092a C |
102 | authenticate, |
103 | asyncMiddleware(videoPlaylistsReorderVideosValidator), | |
104 | asyncRetryTransactionMiddleware(reorderVideosPlaylist) | |
105 | ) | |
106 | ||
107 | videoPlaylistRouter.put('/:playlistId/videos/:videoId', | |
108 | authenticate, | |
109 | asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator), | |
110 | asyncRetryTransactionMiddleware(updateVideoPlaylistElement) | |
111 | ) | |
112 | ||
113 | videoPlaylistRouter.delete('/:playlistId/videos/:videoId', | |
114 | authenticate, | |
115 | asyncMiddleware(videoPlaylistsUpdateOrRemoveVideoValidator), | |
116 | asyncRetryTransactionMiddleware(removeVideoFromPlaylist) | |
117 | ) | |
118 | ||
119 | // --------------------------------------------------------------------------- | |
120 | ||
121 | export { | |
122 | videoPlaylistRouter | |
123 | } | |
124 | ||
125 | // --------------------------------------------------------------------------- | |
126 | ||
d4c9f45b C |
127 | function listVideoPlaylistPrivacies (req: express.Request, res: express.Response) { |
128 | res.json(VIDEO_PLAYLIST_PRIVACIES) | |
129 | } | |
130 | ||
418d092a C |
131 | async function listVideoPlaylists (req: express.Request, res: express.Response) { |
132 | const serverActor = await getServerActor() | |
133 | const resultList = await VideoPlaylistModel.listForApi({ | |
134 | followerActorId: serverActor.id, | |
135 | start: req.query.start, | |
136 | count: req.query.count, | |
df0b219d C |
137 | sort: req.query.sort, |
138 | type: req.query.type | |
418d092a C |
139 | }) |
140 | ||
141 | return res.json(getFormattedObjects(resultList.data, resultList.total)) | |
142 | } | |
143 | ||
144 | function getVideoPlaylist (req: express.Request, res: express.Response) { | |
dae86118 | 145 | const videoPlaylist = res.locals.videoPlaylist |
418d092a | 146 | |
9f79ade6 C |
147 | if (videoPlaylist.isOutdated()) { |
148 | JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video-playlist', url: videoPlaylist.url } }) | |
149 | .catch(err => logger.error('Cannot create AP refresher job for playlist %s.', videoPlaylist.url, { err })) | |
150 | } | |
151 | ||
418d092a C |
152 | return res.json(videoPlaylist.toFormattedJSON()) |
153 | } | |
154 | ||
155 | async function addVideoPlaylist (req: express.Request, res: express.Response) { | |
156 | const videoPlaylistInfo: VideoPlaylistCreate = req.body | |
dae86118 | 157 | const user = res.locals.oauth.token.User |
418d092a C |
158 | |
159 | const videoPlaylist = new VideoPlaylistModel({ | |
160 | name: videoPlaylistInfo.displayName, | |
161 | description: videoPlaylistInfo.description, | |
162 | privacy: videoPlaylistInfo.privacy || VideoPlaylistPrivacy.PRIVATE, | |
163 | ownerAccountId: user.Account.id | |
164 | }) | |
165 | ||
166 | videoPlaylist.url = getVideoPlaylistActivityPubUrl(videoPlaylist) // We use the UUID, so set the URL after building the object | |
167 | ||
d4c9f45b | 168 | if (videoPlaylistInfo.videoChannelId) { |
dae86118 | 169 | const videoChannel = res.locals.videoChannel |
418d092a C |
170 | |
171 | videoPlaylist.videoChannelId = videoChannel.id | |
172 | videoPlaylist.VideoChannel = videoChannel | |
173 | } | |
174 | ||
175 | const thumbnailField = req.files['thumbnailfile'] | |
e8bafea3 | 176 | const thumbnailModel = thumbnailField |
3acc5084 | 177 | ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylist) |
e8bafea3 | 178 | : undefined |
418d092a C |
179 | |
180 | const videoPlaylistCreated: VideoPlaylistModel = await sequelizeTypescript.transaction(async t => { | |
181 | const videoPlaylistCreated = await videoPlaylist.save({ transaction: t }) | |
182 | ||
3acc5084 | 183 | if (thumbnailModel) await videoPlaylistCreated.setAndSaveThumbnail(thumbnailModel, t) |
e8bafea3 | 184 | |
df0b219d C |
185 | // We need more attributes for the federation |
186 | videoPlaylistCreated.OwnerAccount = await AccountModel.load(user.Account.id, t) | |
418d092a C |
187 | await sendCreateVideoPlaylist(videoPlaylistCreated, t) |
188 | ||
189 | return videoPlaylistCreated | |
190 | }) | |
191 | ||
192 | logger.info('Video playlist with uuid %s created.', videoPlaylist.uuid) | |
193 | ||
194 | return res.json({ | |
195 | videoPlaylist: { | |
196 | id: videoPlaylistCreated.id, | |
197 | uuid: videoPlaylistCreated.uuid | |
198 | } | |
199 | }).end() | |
200 | } | |
201 | ||
202 | async function updateVideoPlaylist (req: express.Request, res: express.Response) { | |
dae86118 | 203 | const videoPlaylistInstance = res.locals.videoPlaylist |
418d092a C |
204 | const videoPlaylistFieldsSave = videoPlaylistInstance.toJSON() |
205 | const videoPlaylistInfoToUpdate = req.body as VideoPlaylistUpdate | |
206 | const wasPrivatePlaylist = videoPlaylistInstance.privacy === VideoPlaylistPrivacy.PRIVATE | |
207 | ||
208 | const thumbnailField = req.files['thumbnailfile'] | |
e8bafea3 | 209 | const thumbnailModel = thumbnailField |
3acc5084 | 210 | ? await createPlaylistMiniatureFromExisting(thumbnailField[0].path, videoPlaylistInstance) |
e8bafea3 | 211 | : undefined |
418d092a C |
212 | |
213 | try { | |
214 | await sequelizeTypescript.transaction(async t => { | |
215 | const sequelizeOptions = { | |
216 | transaction: t | |
217 | } | |
218 | ||
219 | if (videoPlaylistInfoToUpdate.videoChannelId !== undefined) { | |
220 | if (videoPlaylistInfoToUpdate.videoChannelId === null) { | |
221 | videoPlaylistInstance.videoChannelId = null | |
222 | } else { | |
dae86118 | 223 | const videoChannel = res.locals.videoChannel |
418d092a C |
224 | |
225 | videoPlaylistInstance.videoChannelId = videoChannel.id | |
df0b219d | 226 | videoPlaylistInstance.VideoChannel = videoChannel |
418d092a C |
227 | } |
228 | } | |
229 | ||
230 | if (videoPlaylistInfoToUpdate.displayName !== undefined) videoPlaylistInstance.name = videoPlaylistInfoToUpdate.displayName | |
231 | if (videoPlaylistInfoToUpdate.description !== undefined) videoPlaylistInstance.description = videoPlaylistInfoToUpdate.description | |
232 | ||
233 | if (videoPlaylistInfoToUpdate.privacy !== undefined) { | |
234 | videoPlaylistInstance.privacy = parseInt(videoPlaylistInfoToUpdate.privacy.toString(), 10) | |
235 | } | |
236 | ||
237 | const playlistUpdated = await videoPlaylistInstance.save(sequelizeOptions) | |
238 | ||
3acc5084 | 239 | if (thumbnailModel) await playlistUpdated.setAndSaveThumbnail(thumbnailModel, t) |
e8bafea3 | 240 | |
418d092a C |
241 | const isNewPlaylist = wasPrivatePlaylist && playlistUpdated.privacy !== VideoPlaylistPrivacy.PRIVATE |
242 | ||
243 | if (isNewPlaylist) { | |
244 | await sendCreateVideoPlaylist(playlistUpdated, t) | |
245 | } else { | |
246 | await sendUpdateVideoPlaylist(playlistUpdated, t) | |
247 | } | |
248 | ||
249 | logger.info('Video playlist %s updated.', videoPlaylistInstance.uuid) | |
250 | ||
251 | return playlistUpdated | |
252 | }) | |
253 | } catch (err) { | |
254 | logger.debug('Cannot update the video playlist.', { err }) | |
255 | ||
256 | // Force fields we want to update | |
257 | // If the transaction is retried, sequelize will think the object has not changed | |
258 | // So it will skip the SQL request, even if the last one was ROLLBACKed! | |
259 | resetSequelizeInstance(videoPlaylistInstance, videoPlaylistFieldsSave) | |
260 | ||
261 | throw err | |
262 | } | |
263 | ||
264 | return res.type('json').status(204).end() | |
265 | } | |
266 | ||
267 | async function removeVideoPlaylist (req: express.Request, res: express.Response) { | |
dae86118 | 268 | const videoPlaylistInstance = res.locals.videoPlaylist |
418d092a C |
269 | |
270 | await sequelizeTypescript.transaction(async t => { | |
271 | await videoPlaylistInstance.destroy({ transaction: t }) | |
272 | ||
273 | await sendDeleteVideoPlaylist(videoPlaylistInstance, t) | |
274 | ||
275 | logger.info('Video playlist %s deleted.', videoPlaylistInstance.uuid) | |
276 | }) | |
277 | ||
278 | return res.type('json').status(204).end() | |
279 | } | |
280 | ||
281 | async function addVideoInPlaylist (req: express.Request, res: express.Response) { | |
282 | const body: VideoPlaylistElementCreate = req.body | |
dae86118 C |
283 | const videoPlaylist = res.locals.videoPlaylist |
284 | const video = res.locals.video | |
418d092a C |
285 | |
286 | const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => { | |
287 | const position = await VideoPlaylistElementModel.getNextPositionOf(videoPlaylist.id, t) | |
288 | ||
289 | const playlistElement = await VideoPlaylistElementModel.create({ | |
290 | url: getVideoPlaylistElementActivityPubUrl(videoPlaylist, video), | |
291 | position, | |
292 | startTimestamp: body.startTimestamp || null, | |
293 | stopTimestamp: body.stopTimestamp || null, | |
294 | videoPlaylistId: videoPlaylist.id, | |
295 | videoId: video.id | |
296 | }, { transaction: t }) | |
297 | ||
2a10aab3 | 298 | videoPlaylist.changed('updatedAt', true) |
f0a39880 | 299 | await videoPlaylist.save({ transaction: t }) |
418d092a C |
300 | |
301 | await sendUpdateVideoPlaylist(videoPlaylist, t) | |
302 | ||
303 | return playlistElement | |
304 | }) | |
305 | ||
f0a39880 | 306 | // If the user did not set a thumbnail, automatically take the video thumbnail |
5fb6996b | 307 | if (videoPlaylist.hasThumbnail() === false) { |
e8bafea3 | 308 | logger.info('Generating default thumbnail to playlist %s.', videoPlaylist.url) |
f0a39880 | 309 | |
3acc5084 C |
310 | const inputPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getMiniature().filename) |
311 | const thumbnailModel = await createPlaylistMiniatureFromExisting(inputPath, videoPlaylist, true) | |
f0a39880 | 312 | |
e8bafea3 C |
313 | thumbnailModel.videoPlaylistId = videoPlaylist.id |
314 | ||
315 | await thumbnailModel.save() | |
f0a39880 C |
316 | } |
317 | ||
418d092a C |
318 | logger.info('Video added in playlist %s at position %d.', videoPlaylist.uuid, playlistElement.position) |
319 | ||
320 | return res.json({ | |
321 | videoPlaylistElement: { | |
322 | id: playlistElement.id | |
323 | } | |
324 | }).end() | |
325 | } | |
326 | ||
327 | async function updateVideoPlaylistElement (req: express.Request, res: express.Response) { | |
328 | const body: VideoPlaylistElementUpdate = req.body | |
dae86118 C |
329 | const videoPlaylist = res.locals.videoPlaylist |
330 | const videoPlaylistElement = res.locals.videoPlaylistElement | |
418d092a C |
331 | |
332 | const playlistElement: VideoPlaylistElementModel = await sequelizeTypescript.transaction(async t => { | |
333 | if (body.startTimestamp !== undefined) videoPlaylistElement.startTimestamp = body.startTimestamp | |
334 | if (body.stopTimestamp !== undefined) videoPlaylistElement.stopTimestamp = body.stopTimestamp | |
335 | ||
336 | const element = await videoPlaylistElement.save({ transaction: t }) | |
337 | ||
2a10aab3 | 338 | videoPlaylist.changed('updatedAt', true) |
f0a39880 C |
339 | await videoPlaylist.save({ transaction: t }) |
340 | ||
418d092a C |
341 | await sendUpdateVideoPlaylist(videoPlaylist, t) |
342 | ||
343 | return element | |
344 | }) | |
345 | ||
346 | logger.info('Element of position %d of playlist %s updated.', playlistElement.position, videoPlaylist.uuid) | |
347 | ||
348 | return res.type('json').status(204).end() | |
349 | } | |
350 | ||
351 | async function removeVideoFromPlaylist (req: express.Request, res: express.Response) { | |
dae86118 C |
352 | const videoPlaylistElement = res.locals.videoPlaylistElement |
353 | const videoPlaylist = res.locals.videoPlaylist | |
418d092a C |
354 | const positionToDelete = videoPlaylistElement.position |
355 | ||
356 | await sequelizeTypescript.transaction(async t => { | |
357 | await videoPlaylistElement.destroy({ transaction: t }) | |
358 | ||
359 | // Decrease position of the next elements | |
360 | await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, positionToDelete, null, -1, t) | |
361 | ||
2a10aab3 | 362 | videoPlaylist.changed('updatedAt', true) |
f0a39880 C |
363 | await videoPlaylist.save({ transaction: t }) |
364 | ||
418d092a C |
365 | await sendUpdateVideoPlaylist(videoPlaylist, t) |
366 | ||
367 | logger.info('Video playlist element %d of playlist %s deleted.', videoPlaylistElement.position, videoPlaylist.uuid) | |
368 | }) | |
369 | ||
370 | return res.type('json').status(204).end() | |
371 | } | |
372 | ||
373 | async function reorderVideosPlaylist (req: express.Request, res: express.Response) { | |
dae86118 | 374 | const videoPlaylist = res.locals.videoPlaylist |
15e9d5ca | 375 | const body: VideoPlaylistReorder = req.body |
418d092a | 376 | |
15e9d5ca C |
377 | const start: number = body.startPosition |
378 | const insertAfter: number = body.insertAfterPosition | |
379 | const reorderLength: number = body.reorderLength || 1 | |
418d092a C |
380 | |
381 | if (start === insertAfter) { | |
382 | return res.status(204).end() | |
383 | } | |
384 | ||
385 | // Example: if we reorder position 2 and insert after position 5 (so at position 6): # 1 2 3 4 5 6 7 8 9 | |
386 | // * increase position when position > 5 # 1 2 3 4 5 7 8 9 10 | |
387 | // * update position 2 -> position 6 # 1 3 4 5 6 7 8 9 10 | |
388 | // * decrease position when position position > 2 # 1 2 3 4 5 6 7 8 9 | |
389 | await sequelizeTypescript.transaction(async t => { | |
390 | const newPosition = insertAfter + 1 | |
391 | ||
392 | // Add space after the position when we want to insert our reordered elements (increase) | |
393 | await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, newPosition, null, reorderLength, t) | |
394 | ||
395 | let oldPosition = start | |
396 | ||
397 | // We incremented the position of the elements we want to reorder | |
398 | if (start >= newPosition) oldPosition += reorderLength | |
399 | ||
400 | const endOldPosition = oldPosition + reorderLength - 1 | |
401 | // Insert our reordered elements in their place (update) | |
402 | await VideoPlaylistElementModel.reassignPositionOf(videoPlaylist.id, oldPosition, endOldPosition, newPosition, t) | |
403 | ||
404 | // Decrease positions of elements after the old position of our ordered elements (decrease) | |
405 | await VideoPlaylistElementModel.increasePositionOf(videoPlaylist.id, oldPosition, null, -reorderLength, t) | |
406 | ||
2a10aab3 | 407 | videoPlaylist.changed('updatedAt', true) |
f0a39880 C |
408 | await videoPlaylist.save({ transaction: t }) |
409 | ||
418d092a C |
410 | await sendUpdateVideoPlaylist(videoPlaylist, t) |
411 | }) | |
412 | ||
413 | logger.info( | |
414 | 'Reordered playlist %s (inserted after %d elements %d - %d).', | |
415 | videoPlaylist.uuid, insertAfter, start, start + reorderLength - 1 | |
416 | ) | |
417 | ||
418 | return res.type('json').status(204).end() | |
419 | } | |
420 | ||
421 | async function getVideoPlaylistVideos (req: express.Request, res: express.Response) { | |
dae86118 | 422 | const videoPlaylistInstance = res.locals.videoPlaylist |
418d092a C |
423 | const followerActorId = isUserAbleToSearchRemoteURI(res) ? null : undefined |
424 | ||
425 | const resultList = await VideoModel.listForApi({ | |
426 | followerActorId, | |
427 | start: req.query.start, | |
428 | count: req.query.count, | |
429 | sort: 'VideoPlaylistElements.position', | |
430 | includeLocalVideos: true, | |
431 | categoryOneOf: req.query.categoryOneOf, | |
432 | licenceOneOf: req.query.licenceOneOf, | |
433 | languageOneOf: req.query.languageOneOf, | |
434 | tagsOneOf: req.query.tagsOneOf, | |
435 | tagsAllOf: req.query.tagsAllOf, | |
436 | filter: req.query.filter, | |
437 | nsfw: buildNSFWFilter(res, req.query.nsfw), | |
438 | withFiles: false, | |
439 | videoPlaylistId: videoPlaylistInstance.id, | |
440 | user: res.locals.oauth ? res.locals.oauth.token.User : undefined | |
441 | }) | |
442 | ||
df0b219d C |
443 | const additionalAttributes = { playlistInfo: true } |
444 | return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes })) | |
418d092a | 445 | } |