PeerTube/server/controllers/api/videos/update.ts

198 lines
7.4 KiB
TypeScript
Raw Normal View History

2021-08-27 07:32:44 -05:00
import express from 'express'
2021-05-12 07:51:17 -05:00
import { Transaction } from 'sequelize/types'
import { changeVideoChannelShare } from '@server/lib/activitypub/share'
import { addVideoJobsAfterUpdate, buildVideoThumbnailsFromReq, setVideoTags } from '@server/lib/video'
import { setVideoPrivacy } from '@server/lib/video-privacy'
2021-07-16 03:42:24 -05:00
import { openapiOperationDoc } from '@server/middlewares/doc'
2021-05-12 07:51:17 -05:00
import { FilteredModelAttributes } from '@server/types'
import { MVideoFullLight } from '@server/types/models'
import { HttpStatusCode, VideoUpdate } from '@shared/models'
2021-05-12 07:51:17 -05:00
import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger'
import { resetSequelizeInstance } from '../../../helpers/database-utils'
import { createReqFiles } from '../../../helpers/express-utils'
import { logger, loggerTagsFactory } from '../../../helpers/logger'
import { MIMETYPES } from '../../../initializers/constants'
import { sequelizeTypescript } from '../../../initializers/database'
import { Hooks } from '../../../lib/plugins/hooks'
import { autoBlacklistVideoIfNeeded } from '../../../lib/video-blacklist'
import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate, videosUpdateValidator } from '../../../middlewares'
import { ScheduleVideoUpdateModel } from '../../../models/video/schedule-video-update'
import { VideoModel } from '../../../models/video/video'
import { VideoPathManager } from '@server/lib/video-path-manager'
import { forceNumber } from '@shared/core-utils'
2021-05-12 07:51:17 -05:00
const lTags = loggerTagsFactory('api', 'video')
const auditLogger = auditLoggerFactory('videos')
const updateRouter = express.Router()
const reqVideoFileUpdate = createReqFiles([ 'thumbnailfile', 'previewfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
2021-05-12 07:51:17 -05:00
updateRouter.put('/:id',
openapiOperationDoc({ operationId: 'putVideo' }),
2021-05-12 07:51:17 -05:00
authenticate,
reqVideoFileUpdate,
asyncMiddleware(videosUpdateValidator),
asyncRetryTransactionMiddleware(updateVideo)
)
// ---------------------------------------------------------------------------
export {
updateRouter
}
// ---------------------------------------------------------------------------
async function updateVideo (req: express.Request, res: express.Response) {
2021-11-10 07:57:09 -06:00
const videoFromReq = res.locals.videoAll
const oldVideoAuditView = new VideoAuditView(videoFromReq.toFormattedDetailsJSON())
2021-05-12 07:51:17 -05:00
const videoInfoToUpdate: VideoUpdate = req.body
2021-11-10 07:57:09 -06:00
const hadPrivacyForFederation = videoFromReq.hasPrivacyForFederation()
const oldPrivacy = videoFromReq.privacy
2021-05-12 07:51:17 -05:00
const [ thumbnailModel, previewModel ] = await buildVideoThumbnailsFromReq({
2021-11-10 07:57:09 -06:00
video: videoFromReq,
2021-05-12 07:51:17 -05:00
files: req.files,
fallback: () => Promise.resolve(undefined),
automaticallyGenerated: false
})
const videoFileLockReleaser = await VideoPathManager.Instance.lockFiles(videoFromReq.uuid)
2021-05-12 07:51:17 -05:00
try {
const { videoInstanceUpdated, isNewVideo } = await sequelizeTypescript.transaction(async t => {
2021-11-10 07:57:09 -06:00
// Refresh video since thumbnails to prevent concurrent updates
2022-06-28 07:57:51 -05:00
const video = await VideoModel.loadFull(videoFromReq.id, t)
2021-11-10 07:57:09 -06:00
const oldVideoChannel = video.VideoChannel
2021-05-12 07:51:17 -05:00
const keysToUpdate: (keyof VideoUpdate & FilteredModelAttributes<VideoModel>)[] = [
'name',
'category',
'licence',
'language',
'nsfw',
'waitTranscoding',
'support',
'description',
'commentsEnabled',
'downloadEnabled'
]
for (const key of keysToUpdate) {
2021-11-10 07:57:09 -06:00
if (videoInfoToUpdate[key] !== undefined) video.set(key, videoInfoToUpdate[key])
2021-05-12 07:51:17 -05:00
}
if (videoInfoToUpdate.originallyPublishedAt !== undefined && videoInfoToUpdate.originallyPublishedAt !== null) {
2021-11-10 07:57:09 -06:00
video.originallyPublishedAt = new Date(videoInfoToUpdate.originallyPublishedAt)
2021-05-12 07:51:17 -05:00
}
// Privacy update?
let isNewVideo = false
if (videoInfoToUpdate.privacy !== undefined) {
2021-11-10 07:57:09 -06:00
isNewVideo = await updateVideoPrivacy({ videoInstance: video, videoInfoToUpdate, hadPrivacyForFederation, transaction: t })
2021-05-12 07:51:17 -05:00
}
2021-11-10 07:34:02 -06:00
// Force updatedAt attribute change
2021-11-10 07:57:09 -06:00
if (!video.changed()) {
2021-11-10 08:52:22 -06:00
await video.setAsRefreshed(t)
2021-11-10 07:34:02 -06:00
}
const videoInstanceUpdated = await video.save({ transaction: t }) as MVideoFullLight
2021-05-12 07:51:17 -05:00
// Thumbnail & preview updates?
if (thumbnailModel) await videoInstanceUpdated.addAndSaveThumbnail(thumbnailModel, t)
if (previewModel) await videoInstanceUpdated.addAndSaveThumbnail(previewModel, t)
// Video tags update?
if (videoInfoToUpdate.tags !== undefined) {
await setVideoTags({ video: videoInstanceUpdated, tags: videoInfoToUpdate.tags, transaction: t })
}
// Video channel update?
if (res.locals.videoChannel && videoInstanceUpdated.channelId !== res.locals.videoChannel.id) {
await videoInstanceUpdated.$set('VideoChannel', res.locals.videoChannel, { transaction: t })
videoInstanceUpdated.VideoChannel = res.locals.videoChannel
if (hadPrivacyForFederation === true) {
await changeVideoChannelShare(videoInstanceUpdated, oldVideoChannel, t)
}
2021-05-12 07:51:17 -05:00
}
// Schedule an update in the future?
await updateSchedule(videoInstanceUpdated, videoInfoToUpdate, t)
await autoBlacklistVideoIfNeeded({
video: videoInstanceUpdated,
user: res.locals.oauth.token.User,
isRemote: false,
isNew: false,
transaction: t
})
auditLogger.update(
getAuditIdFromRes(res),
new VideoAuditView(videoInstanceUpdated.toFormattedDetailsJSON()),
oldVideoAuditView
)
2021-11-10 07:57:09 -06:00
logger.info('Video with name %s and uuid %s updated.', video.name, video.uuid, lTags(video.uuid))
2021-05-12 07:51:17 -05:00
return { videoInstanceUpdated, isNewVideo }
2021-05-12 07:51:17 -05:00
})
2022-08-08 08:48:17 -05:00
Hooks.runAction('action:api.video.updated', { video: videoInstanceUpdated, body: req.body, req, res })
await addVideoJobsAfterUpdate({
video: videoInstanceUpdated,
nameChanged: !!videoInfoToUpdate.name,
oldPrivacy,
isNewVideo
})
2021-05-12 07:51:17 -05:00
} catch (err) {
// If the transaction is retried, sequelize will think the object has not changed
// So we need to restore the previous fields
resetSequelizeInstance(videoFromReq)
2021-05-12 07:51:17 -05:00
throw err
} finally {
videoFileLockReleaser()
2021-05-12 07:51:17 -05:00
}
return res.type('json')
.status(HttpStatusCode.NO_CONTENT_204)
.end()
}
async function updateVideoPrivacy (options: {
videoInstance: MVideoFullLight
videoInfoToUpdate: VideoUpdate
hadPrivacyForFederation: boolean
transaction: Transaction
}) {
const { videoInstance, videoInfoToUpdate, hadPrivacyForFederation, transaction } = options
const isNewVideo = videoInstance.isNewVideo(videoInfoToUpdate.privacy)
const newPrivacy = forceNumber(videoInfoToUpdate.privacy)
setVideoPrivacy(videoInstance, newPrivacy)
2021-05-12 07:51:17 -05:00
// Unfederate the video if the new privacy is not compatible with federation
if (hadPrivacyForFederation && !videoInstance.hasPrivacyForFederation()) {
await VideoModel.sendDelete(videoInstance, { transaction })
}
return isNewVideo
}
function updateSchedule (videoInstance: MVideoFullLight, videoInfoToUpdate: VideoUpdate, transaction: Transaction) {
if (videoInfoToUpdate.scheduleUpdate) {
return ScheduleVideoUpdateModel.upsert({
videoId: videoInstance.id,
updateAt: new Date(videoInfoToUpdate.scheduleUpdate.updateAt),
privacy: videoInfoToUpdate.scheduleUpdate.privacy || null
}, { transaction })
} else if (videoInfoToUpdate.scheduleUpdate === null) {
return ScheduleVideoUpdateModel.deleteByVideoId(videoInstance.id, transaction)
}
}