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