PeerTube/server/helpers/custom-validators/plugins.ts

165 lines
4.2 KiB
TypeScript
Raw Normal View History

import { exists, isArray, isSafePath } from './misc'
2020-01-07 14:56:07 +01:00
import validator from 'validator'
import { PluginType } from '../../../shared/models/plugins/plugin.type'
import { CONSTRAINTS_FIELDS } from '../../initializers/constants'
2021-12-24 10:40:51 +01:00
import { PluginPackageJSON } from '../../../shared/models/plugins/plugin-package-json.model'
import { isUrlValid } from './activitypub/misc'
const PLUGINS_CONSTRAINTS_FIELDS = CONSTRAINTS_FIELDS.PLUGINS
function isPluginTypeValid (value: any) {
2020-08-06 14:58:01 +02:00
return exists(value) &&
(value === PluginType.PLUGIN || value === PluginType.THEME)
}
function isPluginNameValid (value: string) {
return exists(value) &&
validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) &&
2020-04-30 16:32:24 +02:00
validator.matches(value, /^[a-z-0-9]+$/)
}
2019-07-05 15:28:49 +02:00
function isNpmPluginNameValid (value: string) {
return exists(value) &&
validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) &&
2020-01-06 16:20:01 +01:00
validator.matches(value, /^[a-z\-._0-9]+$/) &&
2019-07-05 15:28:49 +02:00
(value.startsWith('peertube-plugin-') || value.startsWith('peertube-theme-'))
}
function isPluginDescriptionValid (value: string) {
return exists(value) && validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.DESCRIPTION)
}
function isPluginVersionValid (value: string) {
if (!exists(value)) return false
const parts = (value + '').split('.')
return parts.length === 3 && parts.every(p => validator.isInt(p))
}
function isPluginEngineValid (engine: any) {
return exists(engine) && exists(engine.peertube)
}
function isPluginHomepage (value: string) {
2019-08-22 09:41:49 +02:00
return exists(value) && (!value || isUrlValid(value))
}
function isPluginBugs (value: string) {
return exists(value) && (!value || isUrlValid(value))
}
2019-07-26 14:44:50 +02:00
function areStaticDirectoriesValid (staticDirs: any) {
if (!exists(staticDirs) || typeof staticDirs !== 'object') return false
for (const key of Object.keys(staticDirs)) {
if (!isSafePath(staticDirs[key])) return false
}
return true
}
2019-07-26 14:44:50 +02:00
function areClientScriptsValid (clientScripts: any[]) {
return isArray(clientScripts) &&
clientScripts.every(c => {
return isSafePath(c.script) && isArray(c.scopes)
})
}
2019-07-26 14:44:50 +02:00
function areTranslationPathsValid (translations: any) {
if (!exists(translations) || typeof translations !== 'object') return false
for (const key of Object.keys(translations)) {
if (!isSafePath(translations[key])) return false
}
return true
}
function areCSSPathsValid (css: any[]) {
return isArray(css) && css.every(c => isSafePath(c))
}
function isThemeNameValid (name: string) {
return isPluginNameValid(name)
2019-07-09 11:45:19 +02:00
}
2021-12-24 10:40:51 +01:00
function isPackageJSONValid (packageJSON: PluginPackageJSON, pluginType: PluginType) {
let result = true
const badFields: string[] = []
if (!isNpmPluginNameValid(packageJSON.name)) {
result = false
badFields.push('name')
}
if (!isPluginDescriptionValid(packageJSON.description)) {
result = false
badFields.push('description')
}
if (!isPluginEngineValid(packageJSON.engine)) {
result = false
badFields.push('engine')
}
if (!isPluginHomepage(packageJSON.homepage)) {
result = false
badFields.push('homepage')
}
if (!exists(packageJSON.author)) {
result = false
badFields.push('author')
}
if (!isPluginBugs(packageJSON.bugs)) {
result = false
badFields.push('bugs')
}
if (pluginType === PluginType.PLUGIN && !isSafePath(packageJSON.library)) {
result = false
badFields.push('library')
}
if (!areStaticDirectoriesValid(packageJSON.staticDirs)) {
result = false
badFields.push('staticDirs')
}
if (!areCSSPathsValid(packageJSON.css)) {
result = false
badFields.push('css')
}
if (!areClientScriptsValid(packageJSON.clientScripts)) {
result = false
badFields.push('clientScripts')
}
if (!areTranslationPathsValid(packageJSON.translations)) {
result = false
badFields.push('translations')
}
return { result, badFields }
}
function isLibraryCodeValid (library: any) {
2020-01-31 16:56:52 +01:00
return typeof library.register === 'function' &&
typeof library.unregister === 'function'
}
export {
isPluginTypeValid,
isPackageJSONValid,
isThemeNameValid,
isPluginHomepage,
isPluginVersionValid,
isPluginNameValid,
isPluginDescriptionValid,
2019-07-05 15:28:49 +02:00
isLibraryCodeValid,
isNpmPluginNameValid
}