import * as express from 'express'
-import { extname, join } from 'path'
-import { VideoCreate, VideoPrivacy, VideoUpdate } from '../../../../shared'
-import { renamePromise } from '../../../helpers/core-utils'
-import { retryTransactionWrapper } from '../../../helpers/database-utils'
-import { getVideoFileResolution } from '../../../helpers/ffmpeg-utils'
-import { processImage } from '../../../helpers/image-utils'
+import toInt from 'validator/lib/toInt'
+import { pickCommonVideoQuery } from '@server/helpers/query'
+import { doJSONRequest } from '@server/helpers/requests'
+import { LiveManager } from '@server/lib/live'
+import { openapiOperationDoc } from '@server/middlewares/doc'
+import { getServerActor } from '@server/models/application/application'
+import { MVideoAccountLight } from '@server/types/models'
+import { HttpStatusCode } from '../../../../shared/models'
+import { auditLoggerFactory, getAuditIdFromRes, VideoAuditView } from '../../../helpers/audit-logger'
+import { buildNSFWFilter, getCountVideos } from '../../../helpers/express-utils'
import { logger } from '../../../helpers/logger'
-import { createReqFiles, getFormattedObjects, getServerActor, resetSequelizeInstance } from '../../../helpers/utils'
-import {
- CONFIG,
- IMAGE_MIMETYPE_EXT,
- PREVIEWS_SIZE,
- sequelizeTypescript,
- THUMBNAILS_SIZE,
- VIDEO_CATEGORIES,
- VIDEO_LANGUAGES,
- VIDEO_LICENCES,
- VIDEO_MIMETYPE_EXT,
- VIDEO_PRIVACIES
-} from '../../../initializers'
-import { fetchRemoteVideoDescription, getVideoActivityPubUrl, shareVideoByServerAndChannel } from '../../../lib/activitypub'
-import { sendCreateVideo, sendCreateView, sendUpdateVideo } from '../../../lib/activitypub/send'
+import { getFormattedObjects } from '../../../helpers/utils'
+import { REMOTE_SCHEME, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers/constants'
+import { sequelizeTypescript } from '../../../initializers/database'
+import { sendView } from '../../../lib/activitypub/send/send-view'
import { JobQueue } from '../../../lib/job-queue'
+import { Hooks } from '../../../lib/plugins/hooks'
import { Redis } from '../../../lib/redis'
import {
asyncMiddleware,
+ asyncRetryTransactionMiddleware,
authenticate,
+ checkVideoFollowConstraints,
+ commonVideosFiltersValidator,
+ optionalAuthenticate,
paginationValidator,
setDefaultPagination,
- setDefaultSort,
- videosAddValidator,
+ setDefaultVideosSort,
+ videoFileMetadataGetValidator,
+ videosCustomGetValidator,
videosGetValidator,
videosRemoveValidator,
- videosSearchValidator,
- videosSortValidator,
- videosUpdateValidator
+ videosSortValidator
} from '../../../middlewares'
-import { TagModel } from '../../../models/video/tag'
import { VideoModel } from '../../../models/video/video'
import { VideoFileModel } from '../../../models/video/video-file'
-import { abuseVideoRouter } from './abuse'
import { blacklistRouter } from './blacklist'
-import { videoChannelRouter } from './channel'
+import { videoCaptionsRouter } from './captions'
import { videoCommentRouter } from './comment'
+import { videoImportsRouter } from './import'
+import { liveRouter } from './live'
+import { ownershipVideoRouter } from './ownership'
import { rateVideoRouter } from './rate'
+import { updateRouter } from './update'
+import { uploadRouter } from './upload'
+import { watchingRouter } from './watching'
+const auditLogger = auditLoggerFactory('videos')
const videosRouter = express.Router()
-const reqVideoFileAdd = createReqFiles(
- [ 'videofile', 'thumbnailfile', 'previewfile' ],
- Object.assign({}, VIDEO_MIMETYPE_EXT, IMAGE_MIMETYPE_EXT),
- {
- videofile: CONFIG.STORAGE.VIDEOS_DIR,
- thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
- previewfile: CONFIG.STORAGE.PREVIEWS_DIR
- }
-)
-const reqVideoFileUpdate = createReqFiles(
- [ 'thumbnailfile', 'previewfile' ],
- IMAGE_MIMETYPE_EXT,
- {
- thumbnailfile: CONFIG.STORAGE.THUMBNAILS_DIR,
- previewfile: CONFIG.STORAGE.PREVIEWS_DIR
- }
-)
-
-videosRouter.use('/', abuseVideoRouter)
videosRouter.use('/', blacklistRouter)
videosRouter.use('/', rateVideoRouter)
-videosRouter.use('/', videoChannelRouter)
videosRouter.use('/', videoCommentRouter)
-
-videosRouter.get('/categories', listVideoCategories)
-videosRouter.get('/licences', listVideoLicences)
-videosRouter.get('/languages', listVideoLanguages)
-videosRouter.get('/privacies', listVideoPrivacies)
+videosRouter.use('/', videoCaptionsRouter)
+videosRouter.use('/', videoImportsRouter)
+videosRouter.use('/', ownershipVideoRouter)
+videosRouter.use('/', watchingRouter)
+videosRouter.use('/', liveRouter)
+videosRouter.use('/', uploadRouter)
+videosRouter.use('/', updateRouter)
+
+videosRouter.get('/categories',
+ openapiOperationDoc({ operationId: 'getCategories' }),
+ listVideoCategories
+)
+videosRouter.get('/licences',
+ openapiOperationDoc({ operationId: 'getLicences' }),
+ listVideoLicences
+)
+videosRouter.get('/languages',
+ openapiOperationDoc({ operationId: 'getLanguages' }),
+ listVideoLanguages
+)
+videosRouter.get('/privacies',
+ openapiOperationDoc({ operationId: 'getPrivacies' }),
+ listVideoPrivacies
+)
videosRouter.get('/',
+ openapiOperationDoc({ operationId: 'getVideos' }),
paginationValidator,
videosSortValidator,
- setDefaultSort,
+ setDefaultVideosSort,
setDefaultPagination,
+ optionalAuthenticate,
+ commonVideosFiltersValidator,
asyncMiddleware(listVideos)
)
-videosRouter.get('/search',
- videosSearchValidator,
- paginationValidator,
- videosSortValidator,
- setDefaultSort,
- setDefaultPagination,
- asyncMiddleware(searchVideos)
-)
-videosRouter.put('/:id',
- authenticate,
- reqVideoFileUpdate,
- asyncMiddleware(videosUpdateValidator),
- asyncMiddleware(updateVideoRetryWrapper)
-)
-videosRouter.post('/upload',
- authenticate,
- reqVideoFileAdd,
- asyncMiddleware(videosAddValidator),
- asyncMiddleware(addVideoRetryWrapper)
-)
videosRouter.get('/:id/description',
+ openapiOperationDoc({ operationId: 'getVideoDesc' }),
asyncMiddleware(videosGetValidator),
asyncMiddleware(getVideoDescription)
)
+videosRouter.get('/:id/metadata/:videoFileId',
+ asyncMiddleware(videoFileMetadataGetValidator),
+ asyncMiddleware(getVideoFileMetadata)
+)
videosRouter.get('/:id',
- asyncMiddleware(videosGetValidator),
- getVideo
+ openapiOperationDoc({ operationId: 'getVideo' }),
+ optionalAuthenticate,
+ asyncMiddleware(videosCustomGetValidator('for-api')),
+ asyncMiddleware(checkVideoFollowConstraints),
+ asyncMiddleware(getVideo)
)
videosRouter.post('/:id/views',
- asyncMiddleware(videosGetValidator),
+ openapiOperationDoc({ operationId: 'addView' }),
+ asyncMiddleware(videosCustomGetValidator('only-immutable-attributes')),
asyncMiddleware(viewVideo)
)
videosRouter.delete('/:id',
+ openapiOperationDoc({ operationId: 'delVideo' }),
authenticate,
asyncMiddleware(videosRemoveValidator),
- asyncMiddleware(removeVideoRetryWrapper)
+ asyncRetryTransactionMiddleware(removeVideo)
)
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
-function listVideoCategories (req: express.Request, res: express.Response) {
+function listVideoCategories (_req: express.Request, res: express.Response) {
res.json(VIDEO_CATEGORIES)
}
-function listVideoLicences (req: express.Request, res: express.Response) {
+function listVideoLicences (_req: express.Request, res: express.Response) {
res.json(VIDEO_LICENCES)
}
-function listVideoLanguages (req: express.Request, res: express.Response) {
+function listVideoLanguages (_req: express.Request, res: express.Response) {
res.json(VIDEO_LANGUAGES)
}
-function listVideoPrivacies (req: express.Request, res: express.Response) {
+function listVideoPrivacies (_req: express.Request, res: express.Response) {
res.json(VIDEO_PRIVACIES)
}
-// Wrapper to video add that retry the function if there is a database error
-// We need this because we run the transaction in SERIALIZABLE isolation that can fail
-async function addVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
- const options = {
- arguments: [ req, res, req.files['videofile'][0] ],
- errorMessage: 'Cannot insert the video with many retries.'
- }
-
- const video = await retryTransactionWrapper(addVideo, options)
-
- res.json({
- video: {
- id: video.id,
- uuid: video.uuid
- }
- }).end()
-}
-
-async function addVideo (req: express.Request, res: express.Response, videoPhysicalFile: Express.Multer.File) {
- const videoInfo: VideoCreate = req.body
-
- // Prepare data so we don't block the transaction
- const videoData = {
- name: videoInfo.name,
- remote: false,
- extname: extname(videoPhysicalFile.filename),
- category: videoInfo.category,
- licence: videoInfo.licence,
- language: videoInfo.language,
- commentsEnabled: videoInfo.commentsEnabled,
- nsfw: videoInfo.nsfw,
- description: videoInfo.description,
- support: videoInfo.support,
- privacy: videoInfo.privacy,
- duration: videoPhysicalFile['duration'], // duration was added by a previous middleware
- channelId: res.locals.videoChannel.id
- }
- const video = new VideoModel(videoData)
- video.url = getVideoActivityPubUrl(video)
-
- const { videoFileResolution } = await getVideoFileResolution(videoPhysicalFile.path)
-
- const videoFileData = {
- extname: extname(videoPhysicalFile.filename),
- resolution: videoFileResolution,
- size: videoPhysicalFile.size
- }
- const videoFile = new VideoFileModel(videoFileData)
- const videoDir = CONFIG.STORAGE.VIDEOS_DIR
- const destination = join(videoDir, video.getVideoFilename(videoFile))
-
- await renamePromise(videoPhysicalFile.path, destination)
- // This is important in case if there is another attempt in the retry process
- videoPhysicalFile.filename = video.getVideoFilename(videoFile)
- videoPhysicalFile.path = destination
-
- // Process thumbnail or create it from the video
- const thumbnailField = req.files['thumbnailfile']
- if (thumbnailField) {
- const thumbnailPhysicalFile = thumbnailField[0]
- await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, video.getThumbnailName()), THUMBNAILS_SIZE)
- } else {
- await video.createThumbnail(videoFile)
- }
-
- // Process preview or create it from the video
- const previewField = req.files['previewfile']
- if (previewField) {
- const previewPhysicalFile = previewField[0]
- await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, video.getPreviewName()), PREVIEWS_SIZE)
- } else {
- await video.createPreview(videoFile)
- }
-
- await video.createTorrentAndSetInfoHash(videoFile)
-
- const videoCreated = await sequelizeTypescript.transaction(async t => {
- const sequelizeOptions = { transaction: t }
-
- const videoCreated = await video.save(sequelizeOptions)
- // Do not forget to add video channel information to the created video
- videoCreated.VideoChannel = res.locals.videoChannel
+async function getVideo (_req: express.Request, res: express.Response) {
+ const video = res.locals.videoAPI
- videoFile.videoId = video.id
- await videoFile.save(sequelizeOptions)
-
- video.VideoFiles = [ videoFile ]
-
- if (videoInfo.tags) {
- const tagInstances = await TagModel.findOrCreateTags(videoInfo.tags, t)
-
- await video.$set('Tags', tagInstances, sequelizeOptions)
- video.Tags = tagInstances
- }
-
- // Let transcoding job send the video to friends because the video file extension might change
- if (CONFIG.TRANSCODING.ENABLED === true) return videoCreated
- // Don't send video to remote servers, it is private
- if (video.privacy === VideoPrivacy.PRIVATE) return videoCreated
-
- await sendCreateVideo(video, t)
- await shareVideoByServerAndChannel(video, t)
-
- logger.info('Video with name %s and uuid %s created.', videoInfo.name, videoCreated.uuid)
-
- return videoCreated
- })
-
- if (CONFIG.TRANSCODING.ENABLED === true) {
- // Put uuid because we don't have id auto incremented for now
- const dataInput = {
- videoUUID: videoCreated.uuid
- }
-
- await JobQueue.Instance.createJob({ type: 'video-file', payload: dataInput })
+ if (video.isOutdated()) {
+ JobQueue.Instance.createJob({ type: 'activitypub-refresher', payload: { type: 'video', url: video.url } })
}
- return videoCreated
+ return res.json(video.toFormattedDetailsJSON())
}
-async function updateVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
- const options = {
- arguments: [ req, res ],
- errorMessage: 'Cannot update the video with many retries.'
+async function viewVideo (req: express.Request, res: express.Response) {
+ const immutableVideoAttrs = res.locals.onlyImmutableVideo
+
+ const ip = req.ip
+ const exists = await Redis.Instance.doesVideoIPViewExist(ip, immutableVideoAttrs.uuid)
+ if (exists) {
+ logger.debug('View for ip %s and video %s already exists.', ip, immutableVideoAttrs.uuid)
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
- await retryTransactionWrapper(updateVideo, options)
+ const video = await VideoModel.load(immutableVideoAttrs.id)
- return res.type('json').status(204).end()
-}
+ const promises: Promise<any>[] = [
+ Redis.Instance.setIPVideoView(ip, video.uuid, video.isLive)
+ ]
-async function updateVideo (req: express.Request, res: express.Response) {
- const videoInstance: VideoModel = res.locals.video
- const videoFieldsSave = videoInstance.toJSON()
- const videoInfoToUpdate: VideoUpdate = req.body
- const wasPrivateVideo = videoInstance.privacy === VideoPrivacy.PRIVATE
+ let federateView = true
- // Process thumbnail or create it from the video
- if (req.files && req.files['thumbnailfile']) {
- const thumbnailPhysicalFile = req.files['thumbnailfile'][0]
- await processImage(thumbnailPhysicalFile, join(CONFIG.STORAGE.THUMBNAILS_DIR, videoInstance.getThumbnailName()), THUMBNAILS_SIZE)
- }
+ // Increment our live manager
+ if (video.isLive && video.isOwned()) {
+ LiveManager.Instance.addViewTo(video.id)
- // Process preview or create it from the video
- if (req.files && req.files['previewfile']) {
- const previewPhysicalFile = req.files['previewfile'][0]
- await processImage(previewPhysicalFile, join(CONFIG.STORAGE.PREVIEWS_DIR, videoInstance.getPreviewName()), PREVIEWS_SIZE)
+ // Views of our local live will be sent by our live manager
+ federateView = false
}
- try {
- await sequelizeTypescript.transaction(async t => {
- const sequelizeOptions = {
- transaction: t
- }
-
- if (videoInfoToUpdate.name !== undefined) videoInstance.set('name', videoInfoToUpdate.name)
- if (videoInfoToUpdate.category !== undefined) videoInstance.set('category', videoInfoToUpdate.category)
- if (videoInfoToUpdate.licence !== undefined) videoInstance.set('licence', videoInfoToUpdate.licence)
- if (videoInfoToUpdate.language !== undefined) videoInstance.set('language', videoInfoToUpdate.language)
- if (videoInfoToUpdate.nsfw !== undefined) videoInstance.set('nsfw', videoInfoToUpdate.nsfw)
- if (videoInfoToUpdate.support !== undefined) videoInstance.set('support', videoInfoToUpdate.support)
- if (videoInfoToUpdate.description !== undefined) videoInstance.set('description', videoInfoToUpdate.description)
- if (videoInfoToUpdate.commentsEnabled !== undefined) videoInstance.set('commentsEnabled', videoInfoToUpdate.commentsEnabled)
- if (videoInfoToUpdate.privacy !== undefined) {
- const newPrivacy = parseInt(videoInfoToUpdate.privacy.toString(), 10)
- videoInstance.set('privacy', newPrivacy)
-
- if (wasPrivateVideo === true && newPrivacy !== VideoPrivacy.PRIVATE) {
- videoInstance.set('publishedAt', new Date())
- }
- }
-
- const videoInstanceUpdated = await videoInstance.save(sequelizeOptions)
-
- if (videoInfoToUpdate.tags) {
- const tagInstances = await TagModel.findOrCreateTags(videoInfoToUpdate.tags, t)
-
- await videoInstance.$set('Tags', tagInstances, sequelizeOptions)
- videoInstance.Tags = tagInstances
- }
-
- // Now we'll update the video's meta data to our friends
- if (wasPrivateVideo === false) {
- await sendUpdateVideo(videoInstanceUpdated, t)
- }
-
- // Video is not private anymore, send a create action to remote servers
- if (wasPrivateVideo === true && videoInstanceUpdated.privacy !== VideoPrivacy.PRIVATE) {
- await sendCreateVideo(videoInstanceUpdated, t)
- await shareVideoByServerAndChannel(videoInstanceUpdated, t)
- }
- })
-
- logger.info('Video with name %s and uuid %s updated.', videoInstance.name, videoInstance.uuid)
- } catch (err) {
- // Force fields we want to update
- // If the transaction is retried, sequelize will think the object has not changed
- // So it will skip the SQL request, even if the last one was ROLLBACKed!
- resetSequelizeInstance(videoInstance, videoFieldsSave)
-
- throw err
+ // Increment our video views cache counter
+ if (!video.isLive) {
+ promises.push(Redis.Instance.addVideoView(video.id))
}
-}
-
-function getVideo (req: express.Request, res: express.Response) {
- const videoInstance = res.locals.video
-
- return res.json(videoInstance.toFormattedDetailsJSON())
-}
-
-async function viewVideo (req: express.Request, res: express.Response) {
- const videoInstance = res.locals.video
- const ip = req.ip
- const exists = await Redis.Instance.isViewExists(ip, videoInstance.uuid)
- if (exists) {
- logger.debug('View for ip %s and video %s already exists.', ip, videoInstance.uuid)
- return res.status(204).end()
+ if (federateView) {
+ const serverActor = await getServerActor()
+ promises.push(sendView(serverActor, video, undefined))
}
- await videoInstance.increment('views')
- await Redis.Instance.setView(ip, videoInstance.uuid)
+ await Promise.all(promises)
- const serverAccount = await getServerActor()
+ Hooks.runAction('action:api.video.viewed', { video, ip })
- await sendCreateView(serverAccount, videoInstance, undefined)
-
- return res.status(204).end()
+ return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
async function getVideoDescription (req: express.Request, res: express.Response) {
- const videoInstance = res.locals.video
- let description = ''
+ const videoInstance = res.locals.videoAll
- if (videoInstance.isOwned()) {
- description = videoInstance.description
- } else {
- description = await fetchRemoteVideoDescription(videoInstance)
- }
+ const description = videoInstance.isOwned()
+ ? videoInstance.description
+ : await fetchRemoteVideoDescription(videoInstance)
return res.json({ description })
}
-async function listVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
- const resultList = await VideoModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.filter)
+async function getVideoFileMetadata (req: express.Request, res: express.Response) {
+ const videoFile = await VideoFileModel.loadWithMetadata(toInt(req.params.videoFileId))
- return res.json(getFormattedObjects(resultList.data, resultList.total))
+ return res.json(videoFile.metadata)
}
-async function removeVideoRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
- const options = {
- arguments: [ req, res ],
- errorMessage: 'Cannot remove the video with many retries.'
- }
+async function listVideos (req: express.Request, res: express.Response) {
+ const query = pickCommonVideoQuery(req.query)
+ const countVideos = getCountVideos(req)
+
+ const apiOptions = await Hooks.wrapObject({
+ ...query,
- await retryTransactionWrapper(removeVideo, options)
+ includeLocalVideos: true,
+ nsfw: buildNSFWFilter(res, query.nsfw),
+ withFiles: false,
+ user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
+ countVideos
+ }, 'filter:api.videos.list.params')
- return res.type('json').status(204).end()
+ const resultList = await Hooks.wrapPromiseFun(
+ VideoModel.listForApi,
+ apiOptions,
+ 'filter:api.videos.list.result'
+ )
+
+ return res.json(getFormattedObjects(resultList.data, resultList.total))
}
-async function removeVideo (req: express.Request, res: express.Response) {
- const videoInstance: VideoModel = res.locals.video
+async function removeVideo (_req: express.Request, res: express.Response) {
+ const videoInstance = res.locals.videoAll
await sequelizeTypescript.transaction(async t => {
await videoInstance.destroy({ transaction: t })
})
+ auditLogger.delete(getAuditIdFromRes(res), new VideoAuditView(videoInstance.toFormattedDetailsJSON()))
logger.info('Video with name %s and uuid %s deleted.', videoInstance.name, videoInstance.uuid)
+
+ Hooks.runAction('action:api.video.deleted', { video: videoInstance })
+
+ return res.type('json')
+ .status(HttpStatusCode.NO_CONTENT_204)
+ .end()
}
-async function searchVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
- const resultList = await VideoModel.searchAndPopulateAccountAndServerAndTags(
- req.query.search,
- req.query.start,
- req.query.count,
- req.query.sort
- )
+// ---------------------------------------------------------------------------
- return res.json(getFormattedObjects(resultList.data, resultList.total))
+// FIXME: Should not exist, we rely on specific API
+async function fetchRemoteVideoDescription (video: MVideoAccountLight) {
+ const host = video.VideoChannel.Account.Actor.Server.host
+ const path = video.getDescriptionAPIPath()
+ const url = REMOTE_SCHEME.HTTP + '://' + host + path
+
+ const { body } = await doJSONRequest<any>(url)
+ return body.description || ''
}
projects / github / Chocobozzz / PeerTube.git / blobdiff