1 import * as express from 'express'
2 import { sanitizeUrl } from '@server/helpers/core-utils'
3 import { doJSONRequest } from '@server/helpers/requests'
4 import { CONFIG } from '@server/initializers/config'
5 import { WEBSERVER } from '@server/initializers/constants'
6 import { Hooks } from '@server/lib/plugins/hooks'
7 import { buildMutedForSearchIndex, isSearchIndexSearch, isURISearch } from '@server/lib/search'
8 import { getServerActor } from '@server/models/application/application'
9 import { HttpStatusCode } from '@shared/models'
10 import { ResultList, VideoChannel } from '@shared/models'
11 import { VideoChannelsSearchQuery } 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'
23 videoChannelsListSearchValidator,
24 videoChannelsSearchSortValidator
25 } from '../../../middlewares'
26 import { VideoChannelModel } from '../../../models/video/video-channel'
27 import { MChannelAccountDefault } from '../../../types/models'
29 const searchChannelsRouter = express.Router()
31 searchChannelsRouter.get('/video-channels',
32 openapiOperationDoc({ operationId: 'searchChannels' }),
35 videoChannelsSearchSortValidator,
38 videoChannelsListSearchValidator,
39 asyncMiddleware(searchVideoChannels)
42 // ---------------------------------------------------------------------------
44 export { searchChannelsRouter }
46 // ---------------------------------------------------------------------------
48 function searchVideoChannels (req: express.Request, res: express.Response) {
49 const query: VideoChannelsSearchQuery = req.query
50 const search = query.search
52 const parts = search.split('@')
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(' '))
58 if (isURISearch(search) || isWebfingerSearch) return searchVideoChannelURI(search, isWebfingerSearch, res)
60 // @username -> username to search in DB
61 if (query.search.startsWith('@')) query.search = query.search.replace(/^@/, '')
63 if (isSearchIndexSearch(query)) {
64 return searchVideoChannelsIndex(query, res)
67 return searchVideoChannelsDB(query, res)
70 async function searchVideoChannelsIndex (query: VideoChannelsSearchQuery, res: express.Response) {
71 const result = await buildMutedForSearchIndex(res)
73 const body = await Hooks.wrapObject(Object.assign(query, result), 'filter:api.search.video-channels.index.list.params')
75 const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/video-channels'
78 logger.debug('Doing video channels search index request on %s.', url, { body })
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')
83 return res.json(jsonResult)
85 logger.warn('Cannot use search index to make video channels search.', { err })
88 status: HttpStatusCode.INTERNAL_SERVER_ERROR_500,
89 message: 'Cannot use search index to make video channels search'
94 async function searchVideoChannelsDB (query: VideoChannelsSearchQuery, res: express.Response) {
95 const serverActor = await getServerActor()
97 const apiOptions = await Hooks.wrapObject({
98 actorId: serverActor.id,
103 }, 'filter:api.search.video-channels.local.list.params')
105 const resultList = await Hooks.wrapPromiseFun(
106 VideoChannelModel.searchForApi,
108 'filter:api.search.video-channels.local.list.result'
111 return res.json(getFormattedObjects(resultList.data, resultList.total))
114 async function searchVideoChannelURI (search: string, isWebfingerSearch: boolean, res: express.Response) {
115 let videoChannel: MChannelAccountDefault
118 if (isWebfingerSearch) {
120 uri = await loadActorUrlOrGetFromWebfinger(search)
122 logger.warn('Cannot load actor URL or get from webfinger.', { search, err })
124 return res.json({ total: 0, data: [] })
128 if (isUserAbleToSearchRemoteURI(res)) {
130 const actor = await getOrCreateAPActor(uri, 'all', true, true)
131 videoChannel = actor.VideoChannel
133 logger.info('Cannot search remote video channel %s.', uri, { err })
136 videoChannel = await VideoChannelModel.loadByUrlAndPopulateAccount(sanitizeLocalUrl(uri))
140 total: videoChannel ? 1 : 0,
141 data: videoChannel ? [ videoChannel.toFormattedJSON() ] : []
145 function sanitizeLocalUrl (url: string) {
148 // Handle alternative channel URLs
149 return url.replace(new RegExp('^' + WEBSERVER.URL + '/c/'), WEBSERVER.URL + '/video-channels/')