server/lib/plugins/plugin-index.ts

   1 import { sanitizeUrl } from '@server/helpers/core-utils'
   2 import { logger } from '@server/helpers/logger'
   3 import { doJSONRequest } from '@server/helpers/requests'
   4 import { CONFIG } from '@server/initializers/config'
   5 import { PEERTUBE_VERSION } from '@server/initializers/constants'
   6 import { PluginModel } from '@server/models/server/plugin'
   7 import {
   8   PeerTubePluginIndex,
   9   PeertubePluginIndexList,
  10   PeertubePluginLatestVersionRequest,
  11   PeertubePluginLatestVersionResponse,
  12   ResultList
  13 } from '@shared/models'
  14 import { PluginManager } from './plugin-manager'
  15
  16 async function listAvailablePluginsFromIndex (options: PeertubePluginIndexList) {
  17   const { start = 0, count = 20, search, sort = 'npmName', pluginType } = options
  18
  19   const searchParams: PeertubePluginIndexList & Record<string, string | number> = {
  20     start,
  21     count,
  22     sort,
  23     pluginType,
  24     search,
  25     currentPeerTubeEngine: options.currentPeerTubeEngine || PEERTUBE_VERSION
  26   }
  27
  28   const uri = CONFIG.PLUGINS.INDEX.URL + '/api/v1/plugins'
  29
  30   try {
  31     const { body } = await doJSONRequest<any>(uri, { searchParams })
  32
  33     logger.debug('Got result from PeerTube index.', { body })
  34
  35     addInstanceInformation(body)
  36
  37     return body as ResultList<PeerTubePluginIndex>
  38   } catch (err) {
  39     logger.error('Cannot list available plugins from index %s.', uri, { err })
  40     return undefined
  41   }
  42 }
  43
  44 function addInstanceInformation (result: ResultList<PeerTubePluginIndex>) {
  45   for (const d of result.data) {
  46     d.installed = PluginManager.Instance.isRegistered(d.npmName)
  47     d.name = PluginModel.normalizePluginName(d.npmName)
  48   }
  49
  50   return result
  51 }
  52
  53 async function getLatestPluginsVersion (npmNames: string[]): Promise<PeertubePluginLatestVersionResponse> {
  54   const bodyRequest: PeertubePluginLatestVersionRequest = {
  55     npmNames,
  56     currentPeerTubeEngine: PEERTUBE_VERSION
  57   }
  58
  59   const uri = sanitizeUrl(CONFIG.PLUGINS.INDEX.URL) + '/api/v1/plugins/latest-version'
  60
  61   const options = {
  62     json: bodyRequest,
  63     method: 'POST' as 'POST'
  64   }
  65   const { body } = await doJSONRequest<PeertubePluginLatestVersionResponse>(uri, options)
  66
  67   return body
  68 }
  69
  70 async function getLatestPluginVersion (npmName: string) {
  71   const results = await getLatestPluginsVersion([ npmName ])
  72
  73   if (Array.isArray(results) === false || results.length !== 1) {
  74     logger.warn('Cannot get latest supported plugin version of %s.', npmName)
  75     return undefined
  76   }
  77
  78   return results[0].latestVersion
  79 }
  80
  81 export {
  82   listAvailablePluginsFromIndex,
  83   getLatestPluginVersion,
  84   getLatestPluginsVersion
  85 }