server/lib/plugins/plugin-manager.ts

   1 import express from 'express'
   2 import { createReadStream, createWriteStream } from 'fs'
   3 import { ensureDir, outputFile, readJSON } from 'fs-extra'
   4 import { Server } from 'http'
   5 import { basename, join } from 'path'
   6 import { decachePlugin } from '@server/helpers/decache'
   7 import { ApplicationModel } from '@server/models/application/application'
   8 import { MOAuthTokenUser, MUser } from '@server/types/models'
   9 import { getCompleteLocale } from '@shared/core-utils'
  10 import {
  11   ClientScriptJSON,
  12   PluginPackageJSON,
  13   PluginTranslation,
  14   PluginTranslationPathsJSON,
  15   RegisterServerHookOptions
  16 } from '@shared/models'
  17 import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks'
  18 import { PluginType } from '../../../shared/models/plugins/plugin.type'
  19 import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server/server-hook.model'
  20 import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins'
  21 import { logger } from '../../helpers/logger'
  22 import { CONFIG } from '../../initializers/config'
  23 import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants'
  24 import { PluginModel } from '../../models/server/plugin'
  25 import { PluginLibrary, RegisterServerAuthExternalOptions, RegisterServerAuthPassOptions, RegisterServerOptions } from '../../types/plugins'
  26 import { ClientHtml } from '../client-html'
  27 import { RegisterHelpers } from './register-helpers'
  28 import { installNpmPlugin, installNpmPluginFromDisk, rebuildNativePlugins, removeNpmPlugin } from './yarn'
  29
  30 export interface RegisteredPlugin {
  31   npmName: string
  32   name: string
  33   version: string
  34   description: string
  35   peertubeEngine: string
  36
  37   type: PluginType
  38
  39   path: string
  40
  41   staticDirs: { [name: string]: string }
  42   clientScripts: { [name: string]: ClientScriptJSON }
  43
  44   css: string[]
  45
  46   // Only if this is a plugin
  47   registerHelpers?: RegisterHelpers
  48   unregister?: Function
  49 }
  50
  51 export interface HookInformationValue {
  52   npmName: string
  53   pluginName: string
  54   handler: Function
  55   priority: number
  56 }
  57
  58 type PluginLocalesTranslations = {
  59   [locale: string]: PluginTranslation
  60 }
  61
  62 export class PluginManager implements ServerHook {
  63
  64   private static instance: PluginManager
  65
  66   private registeredPlugins: { [name: string]: RegisteredPlugin } = {}
  67
  68   private hooks: { [name: string]: HookInformationValue[] } = {}
  69   private translations: PluginLocalesTranslations = {}
  70
  71   private server: Server
  72
  73   private constructor () {
  74   }
  75
  76   init (server: Server) {
  77     this.server = server
  78   }
  79
  80   registerWebSocketRouter () {
  81     this.server.on('upgrade', (request, socket, head) => {
  82       // Check if it's a plugin websocket connection
  83       // No need to destroy the stream when we abort the request
  84       // Other handlers in PeerTube will catch this upgrade event too (socket.io, tracker etc)
  85
  86       const url = request.url
  87
  88       const matched = url.match(`/plugins/([^/]+)/([^/]+/)?ws(/.*)`)
  89       if (!matched) return
  90
  91       const npmName = PluginModel.buildNpmName(matched[1], PluginType.PLUGIN)
  92       const subRoute = matched[3]
  93
  94       const result = this.getRegisteredPluginOrTheme(npmName)
  95       if (!result) return
  96
  97       const routes = result.registerHelpers.getWebSocketRoutes()
  98
  99       const wss = routes.find(r => r.route.startsWith(subRoute))
 100       if (!wss) return
 101
 102       try {
 103         wss.handler(request, socket, head)
 104       } catch (err) {
 105         logger.error('Exception in plugin handler ' + npmName, { err })
 106       }
 107     })
 108   }
 109
 110   // ###################### Getters ######################
 111
 112   isRegistered (npmName: string) {
 113     return !!this.getRegisteredPluginOrTheme(npmName)
 114   }
 115
 116   getRegisteredPluginOrTheme (npmName: string) {
 117     return this.registeredPlugins[npmName]
 118   }
 119
 120   getRegisteredPluginByShortName (name: string) {
 121     const npmName = PluginModel.buildNpmName(name, PluginType.PLUGIN)
 122     const registered = this.getRegisteredPluginOrTheme(npmName)
 123
 124     if (!registered || registered.type !== PluginType.PLUGIN) return undefined
 125
 126     return registered
 127   }
 128
 129   getRegisteredThemeByShortName (name: string) {
 130     const npmName = PluginModel.buildNpmName(name, PluginType.THEME)
 131     const registered = this.getRegisteredPluginOrTheme(npmName)
 132
 133     if (!registered || registered.type !== PluginType.THEME) return undefined
 134
 135     return registered
 136   }
 137
 138   getRegisteredPlugins () {
 139     return this.getRegisteredPluginsOrThemes(PluginType.PLUGIN)
 140   }
 141
 142   getRegisteredThemes () {
 143     return this.getRegisteredPluginsOrThemes(PluginType.THEME)
 144   }
 145
 146   getIdAndPassAuths () {
 147     return this.getRegisteredPlugins()
 148       .map(p => ({
 149         npmName: p.npmName,
 150         name: p.name,
 151         version: p.version,
 152         idAndPassAuths: p.registerHelpers.getIdAndPassAuths()
 153       }))
 154       .filter(v => v.idAndPassAuths.length !== 0)
 155   }
 156
 157   getExternalAuths () {
 158     return this.getRegisteredPlugins()
 159       .map(p => ({
 160         npmName: p.npmName,
 161         name: p.name,
 162         version: p.version,
 163         externalAuths: p.registerHelpers.getExternalAuths()
 164       }))
 165       .filter(v => v.externalAuths.length !== 0)
 166   }
 167
 168   getRegisteredSettings (npmName: string) {
 169     const result = this.getRegisteredPluginOrTheme(npmName)
 170     if (!result || result.type !== PluginType.PLUGIN) return []
 171
 172     return result.registerHelpers.getSettings()
 173   }
 174
 175   getRouter (npmName: string) {
 176     const result = this.getRegisteredPluginOrTheme(npmName)
 177     if (!result || result.type !== PluginType.PLUGIN) return null
 178
 179     return result.registerHelpers.getRouter()
 180   }
 181
 182   getTranslations (locale: string) {
 183     return this.translations[locale] || {}
 184   }
 185
 186   async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
 187     const auth = this.getAuth(token.User.pluginAuth, token.authName)
 188     if (!auth) return true
 189
 190     if (auth.hookTokenValidity) {
 191       try {
 192         const { valid } = await auth.hookTokenValidity({ token, type })
 193
 194         if (valid === false) {
 195           logger.info('Rejecting %s token validity from auth %s of plugin %s', type, token.authName, token.User.pluginAuth)
 196         }
 197
 198         return valid
 199       } catch (err) {
 200         logger.warn('Cannot run check token validity from auth %s of plugin %s.', token.authName, token.User.pluginAuth, { err })
 201         return true
 202       }
 203     }
 204
 205     return true
 206   }
 207
 208   // ###################### External events ######################
 209
 210   async onLogout (npmName: string, authName: string, user: MUser, req: express.Request) {
 211     const auth = this.getAuth(npmName, authName)
 212
 213     if (auth?.onLogout) {
 214       logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
 215
 216       try {
 217         // Force await, in case or onLogout returns a promise
 218         const result = await auth.onLogout(user, req)
 219
 220         return typeof result === 'string'
 221           ? result
 222           : undefined
 223       } catch (err) {
 224         logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
 225       }
 226     }
 227
 228     return undefined
 229   }
 230
 231   async onSettingsChanged (name: string, settings: any) {
 232     const registered = this.getRegisteredPluginByShortName(name)
 233     if (!registered) {
 234       logger.error('Cannot find plugin %s to call on settings changed.', name)
 235     }
 236
 237     for (const cb of registered.registerHelpers.getOnSettingsChangedCallbacks()) {
 238       try {
 239         await cb(settings)
 240       } catch (err) {
 241         logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
 242       }
 243     }
 244   }
 245
 246   // ###################### Hooks ######################
 247
 248   async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {
 249     if (!this.hooks[hookName]) return Promise.resolve(result)
 250
 251     const hookType = getHookType(hookName)
 252
 253     for (const hook of this.hooks[hookName]) {
 254       logger.debug('Running hook %s of plugin %s.', hookName, hook.npmName)
 255
 256       result = await internalRunHook({
 257         handler: hook.handler,
 258         hookType,
 259         result,
 260         params,
 261         onError: err => { logger.error('Cannot run hook %s of plugin %s.', hookName, hook.pluginName, { err }) }
 262       })
 263     }
 264
 265     return result
 266   }
 267
 268   // ###################### Registration ######################
 269
 270   async registerPluginsAndThemes () {
 271     await this.resetCSSGlobalFile()
 272
 273     const plugins = await PluginModel.listEnabledPluginsAndThemes()
 274
 275     for (const plugin of plugins) {
 276       try {
 277         await this.registerPluginOrTheme(plugin)
 278       } catch (err) {
 279         // Try to unregister the plugin
 280         try {
 281           await this.unregister(PluginModel.buildNpmName(plugin.name, plugin.type))
 282         } catch {
 283           // we don't care if we cannot unregister it
 284         }
 285
 286         logger.error('Cannot register plugin %s, skipping.', plugin.name, { err })
 287       }
 288     }
 289
 290     this.sortHooksByPriority()
 291   }
 292
 293   // Don't need the plugin type since themes cannot register server code
 294   async unregister (npmName: string) {
 295     logger.info('Unregister plugin %s.', npmName)
 296
 297     const plugin = this.getRegisteredPluginOrTheme(npmName)
 298
 299     if (!plugin) {
 300       throw new Error(`Unknown plugin ${npmName} to unregister`)
 301     }
 302
 303     delete this.registeredPlugins[plugin.npmName]
 304
 305     this.deleteTranslations(plugin.npmName)
 306
 307     if (plugin.type === PluginType.PLUGIN) {
 308       await plugin.unregister()
 309
 310       // Remove hooks of this plugin
 311       for (const key of Object.keys(this.hooks)) {
 312         this.hooks[key] = this.hooks[key].filter(h => h.npmName !== npmName)
 313       }
 314
 315       const store = plugin.registerHelpers
 316       store.reinitVideoConstants(plugin.npmName)
 317       store.reinitTranscodingProfilesAndEncoders(plugin.npmName)
 318
 319       logger.info('Regenerating registered plugin CSS to global file.')
 320       await this.regeneratePluginGlobalCSS()
 321     }
 322
 323     ClientHtml.invalidCache()
 324   }
 325
 326   // ###################### Installation ######################
 327
 328   async install (options: {
 329     toInstall: string
 330     version?: string
 331     fromDisk?: boolean // default false
 332     register?: boolean // default true
 333   }) {
 334     const { toInstall, version, fromDisk = false, register = true } = options
 335
 336     let plugin: PluginModel
 337     let npmName: string
 338
 339     logger.info('Installing plugin %s.', toInstall)
 340
 341     try {
 342       fromDisk
 343         ? await installNpmPluginFromDisk(toInstall)
 344         : await installNpmPlugin(toInstall, version)
 345
 346       npmName = fromDisk ? basename(toInstall) : toInstall
 347       const pluginType = PluginModel.getTypeFromNpmName(npmName)
 348       const pluginName = PluginModel.normalizePluginName(npmName)
 349
 350       const packageJSON = await this.getPackageJSON(pluginName, pluginType)
 351
 352       this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, pluginType);
 353
 354       [ plugin ] = await PluginModel.upsert({
 355         name: pluginName,
 356         description: packageJSON.description,
 357         homepage: packageJSON.homepage,
 358         type: pluginType,
 359         version: packageJSON.version,
 360         enabled: true,
 361         uninstalled: false,
 362         peertubeEngine: packageJSON.engine.peertube
 363       }, { returning: true })
 364
 365       logger.info('Successful installation of plugin %s.', toInstall)
 366
 367       if (register) {
 368         await this.registerPluginOrTheme(plugin)
 369       }
 370     } catch (rootErr) {
 371       logger.error('Cannot install plugin %s, removing it...', toInstall, { err: rootErr })
 372
 373       try {
 374         await this.uninstall({ npmName })
 375       } catch (err) {
 376         logger.error('Cannot uninstall plugin %s after failed installation.', toInstall, { err })
 377
 378         try {
 379           await removeNpmPlugin(npmName)
 380         } catch (err) {
 381           logger.error('Cannot remove plugin %s after failed installation.', toInstall, { err })
 382         }
 383       }
 384
 385       throw rootErr
 386     }
 387
 388     return plugin
 389   }
 390
 391   async update (toUpdate: string, fromDisk = false) {
 392     const npmName = fromDisk ? basename(toUpdate) : toUpdate
 393
 394     logger.info('Updating plugin %s.', npmName)
 395
 396     // Use the latest version from DB, to not upgrade to a version that does not support our PeerTube version
 397     let version: string
 398     if (!fromDisk) {
 399       const plugin = await PluginModel.loadByNpmName(toUpdate)
 400       version = plugin.latestVersion
 401     }
 402
 403     // Unregister old hooks
 404     await this.unregister(npmName)
 405
 406     return this.install({ toInstall: toUpdate, version, fromDisk })
 407   }
 408
 409   async uninstall (options: {
 410     npmName: string
 411     unregister?: boolean // default true
 412   }) {
 413     const { npmName, unregister = true } = options
 414
 415     logger.info('Uninstalling plugin %s.', npmName)
 416
 417     if (unregister) {
 418       try {
 419         await this.unregister(npmName)
 420       } catch (err) {
 421         logger.warn('Cannot unregister plugin %s.', npmName, { err })
 422       }
 423     }
 424
 425     const plugin = await PluginModel.loadByNpmName(npmName)
 426     if (!plugin || plugin.uninstalled === true) {
 427       logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
 428       return
 429     }
 430
 431     plugin.enabled = false
 432     plugin.uninstalled = true
 433
 434     await plugin.save()
 435
 436     await removeNpmPlugin(npmName)
 437
 438     logger.info('Plugin %s uninstalled.', npmName)
 439   }
 440
 441   async rebuildNativePluginsIfNeeded () {
 442     if (!await ApplicationModel.nodeABIChanged()) return
 443
 444     return rebuildNativePlugins()
 445   }
 446
 447   // ###################### Private register ######################
 448
 449   private async registerPluginOrTheme (plugin: PluginModel) {
 450     const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
 451
 452     logger.info('Registering plugin or theme %s.', npmName)
 453
 454     const packageJSON = await this.getPackageJSON(plugin.name, plugin.type)
 455     const pluginPath = this.getPluginPath(plugin.name, plugin.type)
 456
 457     this.sanitizeAndCheckPackageJSONOrThrow(packageJSON, plugin.type)
 458
 459     let library: PluginLibrary
 460     let registerHelpers: RegisterHelpers
 461     if (plugin.type === PluginType.PLUGIN) {
 462       const result = await this.registerPlugin(plugin, pluginPath, packageJSON)
 463       library = result.library
 464       registerHelpers = result.registerStore
 465     }
 466
 467     const clientScripts: { [id: string]: ClientScriptJSON } = {}
 468     for (const c of packageJSON.clientScripts) {
 469       clientScripts[c.script] = c
 470     }
 471
 472     this.registeredPlugins[npmName] = {
 473       npmName,
 474       name: plugin.name,
 475       type: plugin.type,
 476       version: plugin.version,
 477       description: plugin.description,
 478       peertubeEngine: plugin.peertubeEngine,
 479       path: pluginPath,
 480       staticDirs: packageJSON.staticDirs,
 481       clientScripts,
 482       css: packageJSON.css,
 483       registerHelpers: registerHelpers || undefined,
 484       unregister: library ? library.unregister : undefined
 485     }
 486
 487     await this.addTranslations(plugin, npmName, packageJSON.translations)
 488
 489     ClientHtml.invalidCache()
 490   }
 491
 492   private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJSON) {
 493     const npmName = PluginModel.buildNpmName(plugin.name, plugin.type)
 494
 495     // Delete cache if needed
 496     const modulePath = join(pluginPath, packageJSON.library)
 497     decachePlugin(pluginPath, modulePath)
 498     const library: PluginLibrary = require(modulePath)
 499
 500     if (!isLibraryCodeValid(library)) {
 501       throw new Error('Library code is not valid (miss register or unregister function)')
 502     }
 503
 504     const { registerOptions, registerStore } = this.getRegisterHelpers(npmName, plugin)
 505
 506     await ensureDir(registerOptions.peertubeHelpers.plugin.getDataDirectoryPath())
 507
 508     await library.register(registerOptions)
 509
 510     logger.info('Add plugin %s CSS to global file.', npmName)
 511
 512     await this.addCSSToGlobalFile(pluginPath, packageJSON.css)
 513
 514     return { library, registerStore }
 515   }
 516
 517   // ###################### Translations ######################
 518
 519   private async addTranslations (plugin: PluginModel, npmName: string, translationPaths: PluginTranslationPathsJSON) {
 520     for (const locale of Object.keys(translationPaths)) {
 521       const path = translationPaths[locale]
 522       const json = await readJSON(join(this.getPluginPath(plugin.name, plugin.type), path))
 523
 524       const completeLocale = getCompleteLocale(locale)
 525
 526       if (!this.translations[completeLocale]) this.translations[completeLocale] = {}
 527       this.translations[completeLocale][npmName] = json
 528
 529       logger.info('Added locale %s of plugin %s.', completeLocale, npmName)
 530     }
 531   }
 532
 533   private deleteTranslations (npmName: string) {
 534     for (const locale of Object.keys(this.translations)) {
 535       delete this.translations[locale][npmName]
 536
 537       logger.info('Deleted locale %s of plugin %s.', locale, npmName)
 538     }
 539   }
 540
 541   // ###################### CSS ######################
 542
 543   private resetCSSGlobalFile () {
 544     return outputFile(PLUGIN_GLOBAL_CSS_PATH, '')
 545   }
 546
 547   private async addCSSToGlobalFile (pluginPath: string, cssRelativePaths: string[]) {
 548     for (const cssPath of cssRelativePaths) {
 549       await this.concatFiles(join(pluginPath, cssPath), PLUGIN_GLOBAL_CSS_PATH)
 550     }
 551   }
 552
 553   private concatFiles (input: string, output: string) {
 554     return new Promise<void>((res, rej) => {
 555       const inputStream = createReadStream(input)
 556       const outputStream = createWriteStream(output, { flags: 'a' })
 557
 558       inputStream.pipe(outputStream)
 559
 560       inputStream.on('end', () => res())
 561       inputStream.on('error', err => rej(err))
 562     })
 563   }
 564
 565   private async regeneratePluginGlobalCSS () {
 566     await this.resetCSSGlobalFile()
 567
 568     for (const plugin of this.getRegisteredPlugins()) {
 569       await this.addCSSToGlobalFile(plugin.path, plugin.css)
 570     }
 571   }
 572
 573   // ###################### Utils ######################
 574
 575   private sortHooksByPriority () {
 576     for (const hookName of Object.keys(this.hooks)) {
 577       this.hooks[hookName].sort((a, b) => {
 578         return b.priority - a.priority
 579       })
 580     }
 581   }
 582
 583   private getPackageJSON (pluginName: string, pluginType: PluginType) {
 584     const pluginPath = join(this.getPluginPath(pluginName, pluginType), 'package.json')
 585
 586     return readJSON(pluginPath) as Promise<PluginPackageJSON>
 587   }
 588
 589   private getPluginPath (pluginName: string, pluginType: PluginType) {
 590     const npmName = PluginModel.buildNpmName(pluginName, pluginType)
 591
 592     return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', npmName)
 593   }
 594
 595   private getAuth (npmName: string, authName: string) {
 596     const plugin = this.getRegisteredPluginOrTheme(npmName)
 597     if (!plugin || plugin.type !== PluginType.PLUGIN) return null
 598
 599     let auths: (RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions)[] = plugin.registerHelpers.getIdAndPassAuths()
 600     auths = auths.concat(plugin.registerHelpers.getExternalAuths())
 601
 602     return auths.find(a => a.authName === authName)
 603   }
 604
 605   // ###################### Private getters ######################
 606
 607   private getRegisteredPluginsOrThemes (type: PluginType) {
 608     const plugins: RegisteredPlugin[] = []
 609
 610     for (const npmName of Object.keys(this.registeredPlugins)) {
 611       const plugin = this.registeredPlugins[npmName]
 612       if (plugin.type !== type) continue
 613
 614       plugins.push(plugin)
 615     }
 616
 617     return plugins
 618   }
 619
 620   // ###################### Generate register helpers ######################
 621
 622   private getRegisterHelpers (
 623     npmName: string,
 624     plugin: PluginModel
 625   ): { registerStore: RegisterHelpers, registerOptions: RegisterServerOptions } {
 626     const onHookAdded = (options: RegisterServerHookOptions) => {
 627       if (!this.hooks[options.target]) this.hooks[options.target] = []
 628
 629       this.hooks[options.target].push({
 630         npmName,
 631         pluginName: plugin.name,
 632         handler: options.handler,
 633         priority: options.priority || 0
 634       })
 635     }
 636
 637     const registerHelpers = new RegisterHelpers(npmName, plugin, this.server, onHookAdded.bind(this))
 638
 639     return {
 640       registerStore: registerHelpers,
 641       registerOptions: registerHelpers.buildRegisterHelpers()
 642     }
 643   }
 644
 645   private sanitizeAndCheckPackageJSONOrThrow (packageJSON: PluginPackageJSON, pluginType: PluginType) {
 646     if (!packageJSON.staticDirs) packageJSON.staticDirs = {}
 647     if (!packageJSON.css) packageJSON.css = []
 648     if (!packageJSON.clientScripts) packageJSON.clientScripts = []
 649     if (!packageJSON.translations) packageJSON.translations = {}
 650
 651     const { result: packageJSONValid, badFields } = isPackageJSONValid(packageJSON, pluginType)
 652     if (!packageJSONValid) {
 653       const formattedFields = badFields.map(f => `"${f}"`)
 654                                        .join(', ')
 655
 656       throw new Error(`PackageJSON is invalid (invalid fields: ${formattedFields}).`)
 657     }
 658   }
 659
 660   static get Instance () {
 661     return this.instance || (this.instance = new this())
 662   }
 663 }