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

   1 import express from 'express'
   2 import { sanitizeUrl } from '@server/helpers/core-utils'
   3 import { pickSearchChannelQuery } from '@server/helpers/query'
   4 import { doJSONRequest } from '@server/helpers/requests'
   5 import { CONFIG } from '@server/initializers/config'
   6 import { WEBSERVER } from '@server/initializers/constants'
   7 import { Hooks } from '@server/lib/plugins/hooks'
   8 import { buildMutedForSearchIndex, isSearchIndexSearch, isURISearch } from '@server/lib/search'
   9 import { getServerActor } from '@server/models/application/application'
  10 import { HttpStatusCode, ResultList, VideoChannel } from '@shared/models'
  11 import { VideoChannelsSearchQueryAfterSanitize } from '../../../../shared/models/search'
  12 import { isUserAbleToSearchRemoteURI } from '../../../helpers/express-utils'
  13 import { logger } from '../../../helpers/logger'
  14 import { getFormattedObjects } from '../../../helpers/utils'
  15 import { getOrCreateAPActor, loadActorUrlOrGetFromWebfinger } from '../../../lib/activitypub/actors'
  16 import {
  17   asyncMiddleware,
  18   openapiOperationDoc,
  19   optionalAuthenticate,
  20   paginationValidator,
  21   setDefaultPagination,
  22   setDefaultSearchSort,
  23   videoChannelsListSearchValidator,
  24   videoChannelsSearchSortValidator
  25 } from '../../../middlewares'
  26 import { VideoChannelModel } from '../../../models/video/video-channel'
  27 import { MChannelAccountDefault } from '../../../types/models'
  28
  29 const searchChannelsRouter = express.Router()
  30
  31 searchChannelsRouter.get('/video-channels',
  32   openapiOperationDoc({ operationId: 'searchChannels' }),
  33   paginationValidator,
  34   setDefaultPagination,
  35   videoChannelsSearchSortValidator,
  36   setDefaultSearchSort,
  37   optionalAuthenticate,
  38   videoChannelsListSearchValidator,
  39   asyncMiddleware(searchVideoChannels)
  40 )
  41
  42 // ---------------------------------------------------------------------------
  43
  44 export { searchChannelsRouter }
  45
  46 // ---------------------------------------------------------------------------
  47
  48 function searchVideoChannels (req: express.Request, res: express.Response) {
  49   const query = pickSearchChannelQuery(req.query)
  50   let search = query.search || ''
  51
  52   const parts = search.split('@')
  53
  54   // Handle strings like @toto@example.com
  55   if (parts.length === 3 && parts[0].length === 0) parts.shift()
  56   const isWebfingerSearch = parts.length === 2 && parts.every(p => p && !p.includes(' '))
  57
  58   if (isURISearch(search) || isWebfingerSearch) return searchVideoChannelURI(search, isWebfingerSearch, res)
  59
  60   // @username -> username to search in DB
  61   if (search.startsWith('@')) search = search.replace(/^@/, '')
  62
  63   if (isSearchIndexSearch(query)) {
  64     return searchVideoChannelsIndex(query, res)
  65   }
  66
  67   return searchVideoChannelsDB(query, res)
  68 }
  69
  70 async function searchVideoChannelsIndex (query: VideoChannelsSearchQueryAfterSanitize, res: express.Response) {
  71   const result = await buildMutedForSearchIndex(res)
  72
  73   const body = await Hooks.wrapObject(Object.assign(query, result), 'filter:api.search.video-channels.index.list.params')
  74
  75   const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/video-channels'
  76
  77   try {
  78     logger.debug('Doing video channels search index request on %s.', url, { body })
  79
  80     const { body: searchIndexResult } = await doJSONRequest<ResultList<VideoChannel>>(url, { method: 'POST', json: body })
  81     const jsonResult = await Hooks.wrapObject(searchIndexResult, 'filter:api.search.video-channels.index.list.result')
  82
  83     return res.json(jsonResult)
  84   } catch (err) {
  85     logger.warn('Cannot use search index to make video channels search.', { err })
  86
  87     return res.fail({
  88       status: HttpStatusCode.INTERNAL_SERVER_ERROR_500,
  89       message: 'Cannot use search index to make video channels search'
  90     })
  91   }
  92 }
  93
  94 async function searchVideoChannelsDB (query: VideoChannelsSearchQueryAfterSanitize, res: express.Response) {
  95   const serverActor = await getServerActor()
  96
  97   const apiOptions = await Hooks.wrapObject({
  98     ...query,
  99
 100     actorId: serverActor.id
 101   }, 'filter:api.search.video-channels.local.list.params')
 102
 103   const resultList = await Hooks.wrapPromiseFun(
 104     VideoChannelModel.searchForApi,
 105     apiOptions,
 106     'filter:api.search.video-channels.local.list.result'
 107   )
 108
 109   return res.json(getFormattedObjects(resultList.data, resultList.total))
 110 }
 111
 112 async function searchVideoChannelURI (search: string, isWebfingerSearch: boolean, res: express.Response) {
 113   let videoChannel: MChannelAccountDefault
 114   let uri = search
 115
 116   if (isWebfingerSearch) {
 117     try {
 118       uri = await loadActorUrlOrGetFromWebfinger(search)
 119     } catch (err) {
 120       logger.warn('Cannot load actor URL or get from webfinger.', { search, err })
 121
 122       return res.json({ total: 0, data: [] })
 123     }
 124   }
 125
 126   if (isUserAbleToSearchRemoteURI(res)) {
 127     try {
 128       const actor = await getOrCreateAPActor(uri, 'all', true, true)
 129       videoChannel = actor.VideoChannel
 130     } catch (err) {
 131       logger.info('Cannot search remote video channel %s.', uri, { err })
 132     }
 133   } else {
 134     videoChannel = await VideoChannelModel.loadByUrlAndPopulateAccount(sanitizeLocalUrl(uri))
 135   }
 136
 137   return res.json({
 138     total: videoChannel ? 1 : 0,
 139     data: videoChannel ? [ videoChannel.toFormattedJSON() ] : []
 140   })
 141 }
 142
 143 function sanitizeLocalUrl (url: string) {
 144   if (!url) return ''
 145
 146   // Handle alternative channel URLs
 147   return url.replace(new RegExp('^' + WEBSERVER.URL + '/c/'), WEBSERVER.URL + '/video-channels/')
 148 }