From 4bc45da342597fb49593fc14c40f8dc5a97bb64e Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 23 Mar 2021 11:54:08 +0100 Subject: Add hooks support for video download --- server/controllers/download.ts | 85 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 74 insertions(+), 11 deletions(-) (limited to 'server/controllers') diff --git a/server/controllers/download.ts b/server/controllers/download.ts index 27caa1518..fd44f10e9 100644 --- a/server/controllers/download.ts +++ b/server/controllers/download.ts @@ -1,8 +1,10 @@ import * as cors from 'cors' import * as express from 'express' +import { logger } from '@server/helpers/logger' import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache' +import { Hooks } from '@server/lib/plugins/hooks' import { getVideoFilePath } from '@server/lib/video-paths' -import { MVideoFile, MVideoFullLight } from '@server/types/models' +import { MStreamingPlaylist, MVideo, MVideoFile, MVideoFullLight } from '@server/types/models' import { HttpStatusCode } from '@shared/core-utils/miscs/http-error-codes' import { VideoStreamingPlaylistType } from '@shared/models' import { STATIC_DOWNLOAD_PATHS } from '../initializers/constants' @@ -14,19 +16,19 @@ downloadRouter.use(cors()) downloadRouter.use( STATIC_DOWNLOAD_PATHS.TORRENTS + ':filename', - downloadTorrent + asyncMiddleware(downloadTorrent) ) downloadRouter.use( STATIC_DOWNLOAD_PATHS.VIDEOS + ':id-:resolution([0-9]+).:extension', asyncMiddleware(videosDownloadValidator), - downloadVideoFile + asyncMiddleware(downloadVideoFile) ) downloadRouter.use( STATIC_DOWNLOAD_PATHS.HLS_VIDEOS + ':id-:resolution([0-9]+)-fragmented.:extension', asyncMiddleware(videosDownloadValidator), - downloadHLSVideoFile + asyncMiddleware(downloadHLSVideoFile) ) // --------------------------------------------------------------------------- @@ -41,28 +43,58 @@ async function downloadTorrent (req: express.Request, res: express.Response) { const result = await VideosTorrentCache.Instance.getFilePath(req.params.filename) if (!result) return res.sendStatus(HttpStatusCode.NOT_FOUND_404) + const allowParameters = { torrentPath: result.path, downloadName: result.downloadName } + + const allowedResult = await Hooks.wrapFun( + isTorrentDownloadAllowed, + allowParameters, + 'filter:api.download.torrent.allowed.result' + ) + + if (!checkAllowResult(res, allowParameters, allowedResult)) return + return res.download(result.path, result.downloadName) } -function downloadVideoFile (req: express.Request, res: express.Response) { +async function downloadVideoFile (req: express.Request, res: express.Response) { const video = res.locals.videoAll const videoFile = getVideoFile(req, video.VideoFiles) if (!videoFile) return res.status(HttpStatusCode.NOT_FOUND_404).end() + const allowParameters = { video, videoFile } + + const allowedResult = await Hooks.wrapFun( + isVideoDownloadAllowed, + allowParameters, + 'filter:api.download.video.allowed.result' + ) + + if (!checkAllowResult(res, allowParameters, allowedResult)) return + return res.download(getVideoFilePath(video, videoFile), `${video.name}-${videoFile.resolution}p${videoFile.extname}`) } -function downloadHLSVideoFile (req: express.Request, res: express.Response) { +async function downloadHLSVideoFile (req: express.Request, res: express.Response) { const video = res.locals.videoAll - const playlist = getHLSPlaylist(video) - if (!playlist) return res.status(HttpStatusCode.NOT_FOUND_404).end + const streamingPlaylist = getHLSPlaylist(video) + if (!streamingPlaylist) return res.status(HttpStatusCode.NOT_FOUND_404).end - const videoFile = getVideoFile(req, playlist.VideoFiles) + const videoFile = getVideoFile(req, streamingPlaylist.VideoFiles) if (!videoFile) return res.status(HttpStatusCode.NOT_FOUND_404).end() - const filename = `${video.name}-${videoFile.resolution}p-${playlist.getStringType()}${videoFile.extname}` - return res.download(getVideoFilePath(playlist, videoFile), filename) + const allowParameters = { video, streamingPlaylist, videoFile } + + const allowedResult = await Hooks.wrapFun( + isVideoDownloadAllowed, + allowParameters, + 'filter:api.download.video.allowed.result' + ) + + if (!checkAllowResult(res, allowParameters, allowedResult)) return + + const filename = `${video.name}-${videoFile.resolution}p-${streamingPlaylist.getStringType()}${videoFile.extname}` + return res.download(getVideoFilePath(streamingPlaylist, videoFile), filename) } function getVideoFile (req: express.Request, files: MVideoFile[]) { @@ -76,3 +108,34 @@ function getHLSPlaylist (video: MVideoFullLight) { return Object.assign(playlist, { Video: video }) } + +type AllowedResult = { + allowed: boolean + errorMessage?: string +} + +function isTorrentDownloadAllowed (_object: { + torrentPath: string +}): AllowedResult { + return { allowed: true } +} + +function isVideoDownloadAllowed (_object: { + video: MVideo + videoFile: MVideoFile + streamingPlaylist?: MStreamingPlaylist +}): AllowedResult { + return { allowed: true } +} + +function checkAllowResult (res: express.Response, allowParameters: any, result?: AllowedResult) { + if (!result || result.allowed !== true) { + logger.info('Download is not allowed.', { result, allowParameters }) + res.status(HttpStatusCode.FORBIDDEN_403) + .json({ error: result.errorMessage || 'Refused download' }) + + return false + } + + return true +} -- cgit v1.2.3