]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/search.ts
First implem global search
[github/Chocobozzz/PeerTube.git] / server / controllers / api / search.ts
index f408e7932ee6451ddd9f303271fee8400b24eeb3..e08e1d79fa15baea1ec64193c49e30e9e6d31cdc 100644 (file)
@@ -1,22 +1,34 @@
 import * as express from 'express'
-import { buildNSFWFilter } from '../../helpers/express-utils'
+import { sanitizeUrl } from '@server/helpers/core-utils'
+import { doRequest } from '@server/helpers/requests'
+import { CONFIG } from '@server/initializers/config'
+import { getOrCreateVideoAndAccountAndChannel } from '@server/lib/activitypub/videos'
+import { AccountBlocklistModel } from '@server/models/account/account-blocklist'
+import { getServerActor } from '@server/models/application/application'
+import { ServerBlocklistModel } from '@server/models/server/server-blocklist'
+import { ResultList, Video, VideoChannel } from '@shared/models'
+import { SearchTargetQuery } from '@shared/models/search/search-target-query.model'
+import { VideoChannelsSearchQuery, VideosSearchQuery } from '../../../shared/models/search'
+import { buildNSFWFilter, isUserAbleToSearchRemoteURI } from '../../helpers/express-utils'
+import { logger } from '../../helpers/logger'
 import { getFormattedObjects } from '../../helpers/utils'
-import { VideoModel } from '../../models/video/video'
+import { loadActorUrlOrGetFromWebfinger } from '../../helpers/webfinger'
+import { getOrCreateActorAndServerAndModel } from '../../lib/activitypub/actor'
 import {
   asyncMiddleware,
   commonVideosFiltersValidator,
   optionalAuthenticate,
   paginationValidator,
-  searchValidator,
   setDefaultPagination,
   setDefaultSearchSort,
-  videosSearchSortValidator
+  videoChannelsSearchSortValidator,
+  videoChannelsSearchValidator,
+  videosSearchSortValidator,
+  videosSearchValidator
 } from '../../middlewares'
-import { VideosSearchQuery } from '../../../shared/models/search'
-import { getOrCreateVideoAndAccountAndChannel } from '../../lib/activitypub'
-import { logger } from '../../helpers/logger'
-import { User } from '../../../shared/models/users'
-import { CONFIG } from '../../initializers/constants'
+import { VideoModel } from '../../models/video/video'
+import { VideoChannelModel } from '../../models/video/video-channel'
+import { MChannelAccountDefault, MVideoAccountLightBlacklistAllFiles } from '../../typings/models'
 
 const searchRouter = express.Router()
 
@@ -27,45 +39,168 @@ searchRouter.get('/videos',
   setDefaultSearchSort,
   optionalAuthenticate,
   commonVideosFiltersValidator,
-  searchValidator,
+  videosSearchValidator,
   asyncMiddleware(searchVideos)
 )
 
+searchRouter.get('/video-channels',
+  paginationValidator,
+  setDefaultPagination,
+  videoChannelsSearchSortValidator,
+  setDefaultSearchSort,
+  optionalAuthenticate,
+  videoChannelsSearchValidator,
+  asyncMiddleware(searchVideoChannels)
+)
+
 // ---------------------------------------------------------------------------
 
 export { searchRouter }
 
 // ---------------------------------------------------------------------------
 
+function searchVideoChannels (req: express.Request, res: express.Response) {
+  const query: VideoChannelsSearchQuery = req.query
+  const search = query.search
+
+  const isURISearch = search.startsWith('http://') || search.startsWith('https://')
+
+  const parts = search.split('@')
+
+  // Handle strings like @toto@example.com
+  if (parts.length === 3 && parts[0].length === 0) parts.shift()
+  const isWebfingerSearch = parts.length === 2 && parts.every(p => p && !p.includes(' '))
+
+  if (isURISearch || isWebfingerSearch) return searchVideoChannelURI(search, isWebfingerSearch, res)
+
+  // @username -> username to search in DB
+  if (query.search.startsWith('@')) query.search = query.search.replace(/^@/, '')
+
+  if (isSearchIndexEnabled(query)) {
+    return searchVideoChannelsIndex(query, res)
+  }
+
+  return searchVideoChannelsDB(query, res)
+}
+
+async function searchVideoChannelsIndex (query: VideoChannelsSearchQuery, res: express.Response) {
+  logger.debug('Doing channels search on search index.')
+
+  const result = await buildMutedForSearchIndex(res)
+
+  const body = Object.assign(query, result)
+
+  const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/video-channels'
+
+  try {
+    const searchIndexResult = await doRequest<ResultList<VideoChannel>>({ uri: url, body, json: true })
+
+    return res.json(searchIndexResult.body)
+  } catch (err) {
+    logger.warn('Cannot use search index to make video channels search.', { err })
+
+    return res.sendStatus(500)
+  }
+}
+
+async function searchVideoChannelsDB (query: VideoChannelsSearchQuery, res: express.Response) {
+  const serverActor = await getServerActor()
+
+  const options = {
+    actorId: serverActor.id,
+    search: query.search,
+    start: query.start,
+    count: query.count,
+    sort: query.sort
+  }
+  const resultList = await VideoChannelModel.searchForApi(options)
+
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
+}
+
+async function searchVideoChannelURI (search: string, isWebfingerSearch: boolean, res: express.Response) {
+  let videoChannel: MChannelAccountDefault
+  let uri = search
+
+  if (isWebfingerSearch) {
+    try {
+      uri = await loadActorUrlOrGetFromWebfinger(search)
+    } catch (err) {
+      logger.warn('Cannot load actor URL or get from webfinger.', { search, err })
+
+      return res.json({ total: 0, data: [] })
+    }
+  }
+
+  if (isUserAbleToSearchRemoteURI(res)) {
+    try {
+      const actor = await getOrCreateActorAndServerAndModel(uri, 'all', true, true)
+      videoChannel = actor.VideoChannel
+    } catch (err) {
+      logger.info('Cannot search remote video channel %s.', uri, { err })
+    }
+  } else {
+    videoChannel = await VideoChannelModel.loadByUrlAndPopulateAccount(uri)
+  }
+
+  return res.json({
+    total: videoChannel ? 1 : 0,
+    data: videoChannel ? [ videoChannel.toFormattedJSON() ] : []
+  })
+}
+
 function searchVideos (req: express.Request, res: express.Response) {
   const query: VideosSearchQuery = req.query
   const search = query.search
+
   if (search && (search.startsWith('http://') || search.startsWith('https://'))) {
-    return searchVideoUrl(search, res)
+    return searchVideoURI(search, res)
+  }
+
+  if (isSearchIndexEnabled(query)) {
+    return searchVideosIndex(query, res)
   }
 
   return searchVideosDB(query, res)
 }
 
+async function searchVideosIndex (query: VideosSearchQuery, res: express.Response) {
+  logger.debug('Doing videos search on search index.')
+
+  const result = await buildMutedForSearchIndex(res)
+
+  const body = Object.assign(query, result)
+
+  const url = sanitizeUrl(CONFIG.SEARCH.SEARCH_INDEX.URL) + '/api/v1/search/videos'
+
+  try {
+    const searchIndexResult = await doRequest<ResultList<Video>>({ uri: url, body, json: true })
+
+    return res.json(searchIndexResult.body)
+  } catch (err) {
+    logger.warn('Cannot use search index to make video search.', { err })
+
+    return res.sendStatus(500)
+  }
+}
+
 async function searchVideosDB (query: VideosSearchQuery, res: express.Response) {
   const options = Object.assign(query, {
     includeLocalVideos: true,
-    nsfw: buildNSFWFilter(res, query.nsfw)
+    nsfw: buildNSFWFilter(res, query.nsfw),
+    filter: query.filter,
+    user: res.locals.oauth ? res.locals.oauth.token.User : undefined
   })
   const resultList = await VideoModel.searchAndPopulateAccountAndServer(options)
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
 
-async function searchVideoUrl (url: string, res: express.Response) {
-  let video: VideoModel
-  const user: User = res.locals.oauth ? res.locals.oauth.token.User : undefined
+async function searchVideoURI (url: string, res: express.Response) {
+  let video: MVideoAccountLightBlacklistAllFiles
 
   // Check if we can fetch a remote video with the URL
-  if (
-    CONFIG.SEARCH.REMOTE_URI.ANONYMOUS === true ||
-    (CONFIG.SEARCH.REMOTE_URI.USERS === true && user !== undefined)
-  ) {
+  if (isUserAbleToSearchRemoteURI(res)) {
     try {
       const syncParam = {
         likes: false,
@@ -76,10 +211,10 @@ async function searchVideoUrl (url: string, res: express.Response) {
         refreshVideo: false
       }
 
-      const res = await getOrCreateVideoAndAccountAndChannel(url, syncParam)
-      video = res ? res.video : undefined
+      const result = await getOrCreateVideoAndAccountAndChannel({ videoObject: url, syncParam })
+      video = result ? result.video : undefined
     } catch (err) {
-      logger.info('Cannot search remote video %s.', url)
+      logger.info('Cannot search remote video %s.', url, { err })
     }
   } else {
     video = await VideoModel.loadByUrlAndPopulateAccount(url)
@@ -90,3 +225,35 @@ async function searchVideoUrl (url: string, res: express.Response) {
     data: video ? [ video.toFormattedJSON() ] : []
   })
 }
+
+function isSearchIndexEnabled (query: SearchTargetQuery) {
+  if (query.searchTarget === 'search-index') return true
+
+  const searchIndexConfig = CONFIG.SEARCH.SEARCH_INDEX
+
+  if (searchIndexConfig.ENABLED !== true) return false
+
+  if (searchIndexConfig.DISABLE_LOCAL_SEARCH) return true
+  if (searchIndexConfig.IS_DEFAULT_SEARCH && !query.searchTarget) return true
+
+  return false
+}
+
+async function buildMutedForSearchIndex (res: express.Response) {
+  const serverActor = await getServerActor()
+  const accountIds = [ serverActor.Account.id ]
+
+  if (res.locals.oauth) {
+    accountIds.push(res.locals.oauth.token.User.Account.id)
+  }
+
+  const [ blockedHosts, blockedAccounts ] = await Promise.all([
+    ServerBlocklistModel.listHostsBlockedBy(accountIds),
+    AccountBlocklistModel.listHandlesBlockedBy(accountIds)
+  ])
+
+  return {
+    blockedHosts,
+    blockedAccounts
+  }
+}