server/controllers/api/search/search-video-playlists.ts

   1 import * as express from 'express'
   2 import { sanitizeUrl } from '@server/helpers/core-utils'
   3 import { isUserAbleToSearchRemoteURI } from '@server/helpers/express-utils'
   4 import { logger } from '@server/helpers/logger'
   5 import { doJSONRequest } from '@server/helpers/requests'
   6 import { getFormattedObjects } from '@server/helpers/utils'
   7 import { CONFIG } from '@server/initializers/config'
   8 import { WEBSERVER } from '@server/initializers/constants'
   9 import { getOrCreateAPVideoPlaylist } from '@server/lib/activitypub/playlists/get'
  10 import { Hooks } from '@server/lib/plugins/hooks'
  11 import { buildMutedForSearchIndex, isSearchIndexSearch, isURISearch } from '@server/lib/search'
  12 import { getServerActor } from '@server/models/application/application'
  13 import { VideoPlaylistModel } from '@server/models/video/video-playlist'
  14 import { MVideoPlaylistFullSummary } from '@server/types/models'
  15 import { HttpStatusCode, ResultList, VideoPlaylist, VideoPlaylistsSearchQuery } from '@shared/models'
  16 import {
  17   asyncMiddleware,
  18   openapiOperationDoc,
  19   optionalAuthenticate,
  20   paginationValidator,
  21   setDefaultPagination,
  22   setDefaultSearchSort,
  23   videoPlaylistsListSearchValidator,
  24   videoPlaylistsSearchSortValidator
  25 } from '../../../middlewares'
  26
  27 const searchPlaylistsRouter = express.Router()
  28
  29 searchPlaylistsRouter.get('/video-playlists',
  30   openapiOperationDoc({ operationId: 'searchPlaylists' }),
  31   paginationValidator,
  32   setDefaultPagination,
  33   videoPlaylistsSearchSortValidator,
  34   setDefaultSearchSort,
  35   optionalAuthenticate,
  36   videoPlaylistsListSearchValidator,
  37   asyncMiddleware(searchVideoPlaylists)
  38 )
  39
  40 // ---------------------------------------------------------------------------
  41
  42 export { searchPlaylistsRouter }
  43
  44 // ---------------------------------------------------------------------------
  45
  46 function searchVideoPlaylists (req: express.Request, res: express.Response) {
  47   const query: VideoPlaylistsSearchQuery = req.query
  48   const search = query.search
  49
  50   if (isURISearch(search)) return searchVideoPlaylistsURI(search, res)
  51
  52   if (isSearchIndexSearch(query)) {
  53     return searchVideoPlaylistsIndex(query, res)
  54   }
  55
  56   return searchVideoPlaylistsDB(query, res)
  57 }
  58
  59 async function searchVideoPlaylistsIndex (query: VideoPlaylistsSearchQuery, res: express.Response) {
  60   const result = await buildMutedForSearchIndex(res)
  61
  62   const body = await Hooks.wrapObject(Object.assign(query, result), 'filter:api.search.video-playlists.index.list.params')
  63
  64   const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/video-playlists'
  65
  66   try {
  67     logger.debug('Doing video playlists search index request on %s.', url, { body })
  68
  69     const { body: searchIndexResult } = await doJSONRequest<ResultList<VideoPlaylist>>(url, { method: 'POST', json: body })
  70     const jsonResult = await Hooks.wrapObject(searchIndexResult, 'filter:api.search.video-playlists.index.list.result')
  71
  72     return res.json(jsonResult)
  73   } catch (err) {
  74     logger.warn('Cannot use search index to make video playlists search.', { err })
  75
  76     return res.fail({
  77       status: HttpStatusCode.INTERNAL_SERVER_ERROR_500,
  78       message: 'Cannot use search index to make video playlists search'
  79     })
  80   }
  81 }
  82
  83 async function searchVideoPlaylistsDB (query: VideoPlaylistsSearchQuery, res: express.Response) {
  84   const serverActor = await getServerActor()
  85
  86   const apiOptions = await Hooks.wrapObject({
  87     followerActorId: serverActor.id,
  88     search: query.search,
  89     start: query.start,
  90     count: query.count,
  91     sort: query.sort,
  92     host: query.host,
  93     uuids: query.uuids
  94   }, 'filter:api.search.video-playlists.local.list.params')
  95
  96   const resultList = await Hooks.wrapPromiseFun(
  97     VideoPlaylistModel.searchForApi,
  98     apiOptions,
  99     'filter:api.search.video-playlists.local.list.result'
 100   )
 101
 102   return res.json(getFormattedObjects(resultList.data, resultList.total))
 103 }
 104
 105 async function searchVideoPlaylistsURI (search: string, res: express.Response) {
 106   let videoPlaylist: MVideoPlaylistFullSummary
 107
 108   if (isUserAbleToSearchRemoteURI(res)) {
 109     try {
 110       videoPlaylist = await getOrCreateAPVideoPlaylist(search)
 111     } catch (err) {
 112       logger.info('Cannot search remote video playlist %s.', search, { err })
 113     }
 114   } else {
 115     videoPlaylist = await VideoPlaylistModel.loadByUrlWithAccountAndChannelSummary(sanitizeLocalUrl(search))
 116   }
 117
 118   return res.json({
 119     total: videoPlaylist ? 1 : 0,
 120     data: videoPlaylist ? [ videoPlaylist.toFormattedJSON() ] : []
 121   })
 122 }
 123
 124 function sanitizeLocalUrl (url: string) {
 125   if (!url) return ''
 126
 127   // Handle alternative channel URLs
 128   return url.replace(new RegExp('^' + WEBSERVER.URL + '/videos/watch/playlist/'), WEBSERVER.URL + '/video-playlists/')
 129             .replace(new RegExp('^' + WEBSERVER.URL + '/w/p/'), WEBSERVER.URL + '/video-playlists/')
 130 }