PeerTube/server/core/lib/plugins/plugin-index.ts

86 lines
2.5 KiB
TypeScript
Raw Normal View History

import { sanitizeUrl } from '@server/helpers/core-utils.js'
import { logger } from '@server/helpers/logger.js'
import { doJSONRequest } from '@server/helpers/requests.js'
import { CONFIG } from '@server/initializers/config.js'
import { PEERTUBE_VERSION } from '@server/initializers/constants.js'
import { PluginModel } from '@server/models/server/plugin.js'
import {
2021-05-11 12:04:47 +02:00
PeerTubePluginIndex,
PeertubePluginIndexList,
PeertubePluginLatestVersionRequest,
2021-05-11 12:04:47 +02:00
PeertubePluginLatestVersionResponse,
ResultList
} from '@peertube/peertube-models'
import { PluginManager } from './plugin-manager.js'
async function listAvailablePluginsFromIndex (options: PeertubePluginIndexList) {
const { start = 0, count = 20, search, sort = 'npmName', pluginType } = options
2021-03-08 14:24:11 +01:00
const searchParams: PeertubePluginIndexList & Record<string, string | number> = {
start,
count,
sort,
pluginType,
search,
2019-07-19 14:36:04 +02:00
currentPeerTubeEngine: options.currentPeerTubeEngine || PEERTUBE_VERSION
}
const uri = CONFIG.PLUGINS.INDEX.URL + '/api/v1/plugins'
2019-07-16 14:52:24 +02:00
try {
2021-03-08 14:24:11 +01:00
const { body } = await doJSONRequest<any>(uri, { searchParams })
2019-07-16 14:52:24 +02:00
logger.debug('Got result from PeerTube index.', { body })
2020-01-31 16:56:52 +01:00
addInstanceInformation(body)
2019-07-16 14:52:24 +02:00
return body as ResultList<PeerTubePluginIndex>
} catch (err) {
logger.error('Cannot list available plugins from index %s.', uri, { err })
return undefined
}
}
2020-01-31 16:56:52 +01:00
function addInstanceInformation (result: ResultList<PeerTubePluginIndex>) {
for (const d of result.data) {
d.installed = PluginManager.Instance.isRegistered(d.npmName)
d.name = PluginModel.normalizePluginName(d.npmName)
}
return result
}
async function getLatestPluginsVersion (npmNames: string[]): Promise<PeertubePluginLatestVersionResponse> {
const bodyRequest: PeertubePluginLatestVersionRequest = {
npmNames,
2019-07-17 10:03:55 +02:00
currentPeerTubeEngine: PEERTUBE_VERSION
}
2020-05-29 16:16:24 +02:00
const uri = sanitizeUrl(CONFIG.PLUGINS.INDEX.URL) + '/api/v1/plugins/latest-version'
2021-03-08 14:24:11 +01:00
const options = {
json: bodyRequest,
method: 'POST' as 'POST'
}
const { body } = await doJSONRequest<PeertubePluginLatestVersionResponse>(uri, options)
return body
}
2021-04-12 10:10:48 +02:00
async function getLatestPluginVersion (npmName: string) {
const results = await getLatestPluginsVersion([ npmName ])
if (Array.isArray(results) === false || results.length !== 1) {
logger.warn('Cannot get latest supported plugin version of %s.', npmName)
return undefined
}
return results[0].latestVersion
}
export {
listAvailablePluginsFromIndex,
2021-04-12 10:10:48 +02:00
getLatestPluginVersion,
getLatestPluginsVersion
}