-import { exists, isArray, isSafePath } from './misc'
-import * as validator from 'validator'
+import validator from 'validator'
+import { PluginPackageJSON } from '../../../shared/models/plugins/plugin-package-json.model'
import { PluginType } from '../../../shared/models/plugins/plugin.type'
import { CONSTRAINTS_FIELDS } from '../../initializers/constants'
-import { PluginPackageJson } from '../../../shared/models/plugins/plugin-package-json.model'
import { isUrlValid } from './activitypub/misc'
+import { exists, isArray, isSafePath } from './misc'
const PLUGINS_CONSTRAINTS_FIELDS = CONSTRAINTS_FIELDS.PLUGINS
function isPluginTypeValid (value: any) {
- return exists(value) && validator.isInt('' + value) && PluginType[value] !== undefined
+ return exists(value) &&
+ (value === PluginType.PLUGIN || value === PluginType.THEME)
}
function isPluginNameValid (value: string) {
return exists(value) &&
validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) &&
- validator.matches(value, /^[a-z\-]+$/)
+ validator.matches(value, /^[a-z-0-9]+$/)
+}
+
+function isNpmPluginNameValid (value: string) {
+ return exists(value) &&
+ validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) &&
+ validator.matches(value, /^[a-z\-._0-9]+$/) &&
+ (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) {
+function isPluginStableVersionValid (value: string) {
if (!exists(value)) return false
const parts = (value + '').split('.')
return parts.length === 3 && parts.every(p => validator.isInt(p))
}
+function isPluginStableOrUnstableVersionValid (value: string) {
+ if (!exists(value)) return false
+
+ // suffix is beta.x or alpha.x
+ const [ stable, suffix ] = value.split('-')
+ if (!isPluginStableVersionValid(stable)) return false
+
+ const suffixRegex = /^(rc|alpha|beta)\.\d+$/
+ if (suffix && !suffixRegex.test(suffix)) return false
+
+ return true
+}
+
function isPluginEngineValid (engine: any) {
return exists(engine) && exists(engine.peertube)
}
-function isStaticDirectoriesValid (staticDirs: any) {
+function isPluginHomepage (value: string) {
+ return exists(value) && (!value || isUrlValid(value))
+}
+
+function isPluginBugs (value: string) {
+ return exists(value) && (!value || isUrlValid(value))
+}
+
+function areStaticDirectoriesValid (staticDirs: any) {
if (!exists(staticDirs) || typeof staticDirs !== 'object') return false
for (const key of Object.keys(staticDirs)) {
return true
}
-function isClientScriptsValid (clientScripts: any[]) {
+function areClientScriptsValid (clientScripts: any[]) {
return isArray(clientScripts) &&
clientScripts.every(c => {
return isSafePath(c.script) && isArray(c.scopes)
})
}
-function isCSSPathsValid (css: any[]) {
+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 isPackageJSONValid (packageJSON: PluginPackageJson, pluginType: PluginType) {
- return isPluginNameValid(packageJSON.name) &&
- isPluginDescriptionValid(packageJSON.description) &&
- isPluginEngineValid(packageJSON.engine) &&
- isUrlValid(packageJSON.homepage) &&
- exists(packageJSON.author) &&
- isUrlValid(packageJSON.bugs) &&
- (pluginType === PluginType.THEME || isSafePath(packageJSON.library)) &&
- isStaticDirectoriesValid(packageJSON.staticDirs) &&
- isCSSPathsValid(packageJSON.css) &&
- isClientScriptsValid(packageJSON.clientScripts)
+function isThemeNameValid (name: string) {
+ return isPluginNameValid(name)
+}
+
+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) {
- return typeof library.register === 'function'
- && typeof library.unregister === 'function'
+ return typeof library.register === 'function' &&
+ typeof library.unregister === 'function'
}
export {
isPluginTypeValid,
isPackageJSONValid,
- isPluginVersionValid,
+ isThemeNameValid,
+ isPluginHomepage,
+ isPluginStableVersionValid,
+ isPluginStableOrUnstableVersionValid,
isPluginNameValid,
isPluginDescriptionValid,
- isLibraryCodeValid
+ isLibraryCodeValid,
+ isNpmPluginNameValid
}