1 import express from 'express'
2 import memoizee from 'memoizee'
3 import { logger } from '@server/helpers/logger'
4 import { Hooks } from '@server/lib/plugins/hooks'
5 import { VideoModel } from '@server/models/video/video'
6 import { CategoryOverview, ChannelOverview, TagOverview, VideosOverview } from '../../../shared/models/overviews'
7 import { buildNSFWFilter } from '../../helpers/express-utils'
8 import { MEMOIZE_TTL, OVERVIEWS } from '../../initializers/constants'
9 import { asyncMiddleware, optionalAuthenticate, videosOverviewValidator } from '../../middlewares'
10 import { TagModel } from '../../models/video/tag'
11 import { getServerActor } from '@server/models/application/application'
13 const overviewsRouter = express.Router()
15 overviewsRouter.get('/videos',
16 videosOverviewValidator,
18 asyncMiddleware(getVideosOverview)
21 // ---------------------------------------------------------------------------
23 export { overviewsRouter }
25 // ---------------------------------------------------------------------------
27 const buildSamples = memoizee(async function () {
28 const [ categories, channels, tags ] = await Promise.all([
29 VideoModel.getRandomFieldSamples('category', OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT),
30 VideoModel.getRandomFieldSamples('channelId', OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT),
31 TagModel.getRandomSamples(OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT)
34 const result = { categories, channels, tags }
36 logger.debug('Building samples for overview endpoint.', { result })
39 }, { maxAge: MEMOIZE_TTL.OVERVIEWS_SAMPLE })
41 // This endpoint could be quite long, but we cache it
42 async function getVideosOverview (req: express.Request, res: express.Response) {
43 const attributes = await buildSamples()
45 const page = req.query.page || 1
46 const index = page - 1
48 const categories: CategoryOverview[] = []
49 const channels: ChannelOverview[] = []
50 const tags: TagOverview[] = []
53 getVideosByCategory(attributes.categories, index, res, categories),
54 getVideosByChannel(attributes.channels, index, res, channels),
55 getVideosByTag(attributes.tags, index, res, tags)
58 const result: VideosOverview = {
64 return res.json(result)
67 async function getVideosByTag (tagsSample: string[], index: number, res: express.Response, acc: TagOverview[]) {
68 if (tagsSample.length <= index) return
70 const tag = tagsSample[index]
71 const videos = await getVideos(res, { tagsOneOf: [ tag ] })
73 if (videos.length === 0) return
81 async function getVideosByCategory (categoriesSample: number[], index: number, res: express.Response, acc: CategoryOverview[]) {
82 if (categoriesSample.length <= index) return
84 const category = categoriesSample[index]
85 const videos = await getVideos(res, { categoryOneOf: [ category ] })
87 if (videos.length === 0) return
90 category: videos[0].category,
95 async function getVideosByChannel (channelsSample: number[], index: number, res: express.Response, acc: ChannelOverview[]) {
96 if (channelsSample.length <= index) return
98 const channelId = channelsSample[index]
99 const videos = await getVideos(res, { videoChannelId: channelId })
101 if (videos.length === 0) return
104 channel: videos[0].channel,
109 async function getVideos (
110 res: express.Response,
111 where: { videoChannelId?: number, tagsOneOf?: string[], categoryOneOf?: number[] }
113 const serverActor = await getServerActor()
115 const query = await Hooks.wrapObject({
119 displayOnlyForFollower: {
120 actorId: serverActor.id,
123 nsfw: buildNSFWFilter(res),
124 user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
128 }, 'filter:api.overviews.videos.list.params')
130 const { data } = await Hooks.wrapPromiseFun(
131 VideoModel.listForApi,
133 'filter:api.overviews.videos.list.result'
136 return data.map(d => d.toFormattedJSON())