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'
23 videoPlaylistsListSearchValidator,
24 videoPlaylistsSearchSortValidator
25 } from '../../../middlewares'
27 const searchPlaylistsRouter = express.Router()
29 searchPlaylistsRouter.get('/video-playlists',
30 openapiOperationDoc({ operationId: 'searchPlaylists' }),
33 videoPlaylistsSearchSortValidator,
36 videoPlaylistsListSearchValidator,
37 asyncMiddleware(searchVideoPlaylists)
40 // ---------------------------------------------------------------------------
42 export { searchPlaylistsRouter }
44 // ---------------------------------------------------------------------------
46 function searchVideoPlaylists (req: express.Request, res: express.Response) {
47 const query: VideoPlaylistsSearchQuery = req.query
48 const search = query.search
50 if (isURISearch(search)) return searchVideoPlaylistsURI(search, res)
52 if (isSearchIndexSearch(query)) {
53 return searchVideoPlaylistsIndex(query, res)
56 return searchVideoPlaylistsDB(query, res)
59 async function searchVideoPlaylistsIndex (query: VideoPlaylistsSearchQuery, res: express.Response) {
60 const result = await buildMutedForSearchIndex(res)
62 const body = await Hooks.wrapObject(Object.assign(query, result), 'filter:api.search.video-playlists.index.list.params')
64 const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/video-playlists'
67 logger.debug('Doing video playlists search index request on %s.', url, { body })
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')
72 return res.json(jsonResult)
74 logger.warn('Cannot use search index to make video playlists search.', { err })
77 status: HttpStatusCode.INTERNAL_SERVER_ERROR_500,
78 message: 'Cannot use search index to make video playlists search'
83 async function searchVideoPlaylistsDB (query: VideoPlaylistsSearchQuery, res: express.Response) {
84 const serverActor = await getServerActor()
86 const apiOptions = await Hooks.wrapObject({
87 followerActorId: serverActor.id,
92 }, 'filter:api.search.video-playlists.local.list.params')
94 const resultList = await Hooks.wrapPromiseFun(
95 VideoPlaylistModel.searchForApi,
97 'filter:api.search.video-playlists.local.list.result'
100 return res.json(getFormattedObjects(resultList.data, resultList.total))
103 async function searchVideoPlaylistsURI (search: string, res: express.Response) {
104 let videoPlaylist: MVideoPlaylistFullSummary
106 if (isUserAbleToSearchRemoteURI(res)) {
108 videoPlaylist = await getOrCreateAPVideoPlaylist(search)
110 logger.info('Cannot search remote video playlist %s.', search, { err })
113 videoPlaylist = await VideoPlaylistModel.loadByUrlWithAccountAndChannelSummary(sanitizeLocalUrl(search))
117 total: videoPlaylist ? 1 : 0,
118 data: videoPlaylist ? [ videoPlaylist.toFormattedJSON() ] : []
122 function sanitizeLocalUrl (url: string) {
125 // Handle alternative channel URLs
126 return url.replace(new RegExp('^' + WEBSERVER.URL + '/videos/watch/playlist/'), WEBSERVER.URL + '/video-playlists/')
127 .replace(new RegExp('^' + WEBSERVER.URL + '/w/p/'), WEBSERVER.URL + '/video-playlists/')