aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/controllers/api/overviews.ts
blob: 34585e557f775e9ac97ee03065a3fe9a3eb5a816 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
import express from 'express'
import memoizee from 'memoizee'
import { logger } from '@server/helpers/logger'
import { Hooks } from '@server/lib/plugins/hooks'
import { VideoModel } from '@server/models/video/video'
import { CategoryOverview, ChannelOverview, TagOverview, VideosOverview } from '../../../shared/models/overviews'
import { buildNSFWFilter } from '../../helpers/express-utils'
import { MEMOIZE_TTL, OVERVIEWS } from '../../initializers/constants'
import { asyncMiddleware, optionalAuthenticate, videosOverviewValidator } from '../../middlewares'
import { TagModel } from '../../models/video/tag'
import { getServerActor } from '@server/models/application/application'

const overviewsRouter = express.Router()

overviewsRouter.get('/videos',
  videosOverviewValidator,
  optionalAuthenticate,
  asyncMiddleware(getVideosOverview)
)

// ---------------------------------------------------------------------------

export { overviewsRouter }

// ---------------------------------------------------------------------------

const buildSamples = memoizee(async function () {
  const [ categories, channels, tags ] = await Promise.all([
    VideoModel.getRandomFieldSamples('category', OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT),
    VideoModel.getRandomFieldSamples('channelId', OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT),
    TagModel.getRandomSamples(OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD, OVERVIEWS.VIDEOS.SAMPLES_COUNT)
  ])

  const result = { categories, channels, tags }

  logger.debug('Building samples for overview endpoint.', { result })

  return result
}, { maxAge: MEMOIZE_TTL.OVERVIEWS_SAMPLE })

// This endpoint could be quite long, but we cache it
async function getVideosOverview (req: express.Request, res: express.Response) {
  const attributes = await buildSamples()

  const page = req.query.page || 1
  const index = page - 1

  const categories: CategoryOverview[] = []
  const channels: ChannelOverview[] = []
  const tags: TagOverview[] = []

  await Promise.all([
    getVideosByCategory(attributes.categories, index, res, categories),
    getVideosByChannel(attributes.channels, index, res, channels),
    getVideosByTag(attributes.tags, index, res, tags)
  ])

  const result: VideosOverview = {
    categories,
    channels,
    tags
  }

  return res.json(result)
}

async function getVideosByTag (tagsSample: string[], index: number, res: express.Response, acc: TagOverview[]) {
  if (tagsSample.length <= index) return

  const tag = tagsSample[index]
  const videos = await getVideos(res, { tagsOneOf: [ tag ] })

  if (videos.length === 0) return

  acc.push({
    tag,
    videos
  })
}

async function getVideosByCategory (categoriesSample: number[], index: number, res: express.Response, acc: CategoryOverview[]) {
  if (categoriesSample.length <= index) return

  const category = categoriesSample[index]
  const videos = await getVideos(res, { categoryOneOf: [ category ] })

  if (videos.length === 0) return

  acc.push({
    category: videos[0].category,
    videos
  })
}

async function getVideosByChannel (channelsSample: number[], index: number, res: express.Response, acc: ChannelOverview[]) {
  if (channelsSample.length <= index) return

  const channelId = channelsSample[index]
  const videos = await getVideos(res, { videoChannelId: channelId })

  if (videos.length === 0) return

  acc.push({
    channel: videos[0].channel,
    videos
  })
}

async function getVideos (
  res: express.Response,
  where: { videoChannelId?: number, tagsOneOf?: string[], categoryOneOf?: number[] }
) {
  const serverActor = await getServerActor()

  const query = await Hooks.wrapObject({
    start: 0,
    count: 12,
    sort: '-createdAt',
    displayOnlyForFollower: {
      actorId: serverActor.id,
      orLocalVideos: true
    },
    nsfw: buildNSFWFilter(res),
    user: res.locals.oauth ? res.locals.oauth.token.User : undefined,
    countVideos: false,

    ...where
  }, 'filter:api.overviews.videos.list.params')

  const { data } = await Hooks.wrapPromiseFun(
    VideoModel.listForApi,
    query,
    'filter:api.overviews.videos.list.result'
  )

  return data.map(d => d.toFormattedJSON())
}