268 lines
8.5 KiB
TypeScript
268 lines
8.5 KiB
TypeScript
'use strict'
|
|
|
|
import * as Logger from 'log4js'
|
|
import { Plugin, socketioRPC } from 'frontblock-generic/Plugin';
|
|
import { ErrorResponse, SuccessResponse } from 'frontblock-generic/Types';
|
|
//import { FrontblockApiConf } from "frontblock/FrontblockApiClient"
|
|
import {PluginManager} from "live-plugin-manager";
|
|
|
|
type pluginEntry = {pluginName:string}
|
|
const pluginList:pluginEntry[] = [
|
|
{pluginName: 'frontblock'}
|
|
//{ pluginPath: '../../paymentmanager/static/Plugin', conf:<FrontblockApiConf>{ apiHost: 'localhost' /*/ 'api.testnet.frontblock.me' */, apiPort: 10001 } },
|
|
//{ pluginPath: '../../htmlsupplier/static/Plugin' },
|
|
// { pluginPath: 'frontblock/FrontblockApiClient', conf:<FrontblockApiConf>{ apiHost: /*/ 'localhost' */ 'api.testnet.frontblock.me' , apiPort: 10001 } }
|
|
]
|
|
|
|
const express = require('express')
|
|
const http = require('http')
|
|
const bsock = require('bsock')
|
|
const kfs = require("key-file-storage").default('conf') //'conf' is a directory that will be generated if it doesn't exist
|
|
Logger.configure({
|
|
appenders: {
|
|
"admin": { type: 'stdout' },
|
|
//app: { type: 'file', filename: 'application.log' }
|
|
},
|
|
categories: {
|
|
default: { appenders: [ 'admin' ], level: 'debug' }
|
|
}
|
|
})
|
|
const logger = Logger.getLogger("admin")
|
|
|
|
const manager = new PluginManager();
|
|
|
|
type hookRPC = { type: 'hook', generator: (socket) => Function, unhook:(uid:string)=>Promise<ErrorResponse|SuccessResponse>}
|
|
type unhookRPC = { type: 'unhook', fn: Function}
|
|
type callRPC = { type: 'call', fn: Function}
|
|
|
|
export type rpcInfo = {
|
|
owner: string,
|
|
name: string,
|
|
args: string,
|
|
info: hookRPC | unhookRPC | callRPC
|
|
}
|
|
|
|
/**
|
|
* FrontblockAdmin
|
|
*
|
|
* The customer-facing dynamic component of the customer backend
|
|
* Supports (un)loading plugins which will be communicated to its library component (See FrontblockLib.ts and the info() RPC)
|
|
*
|
|
* The list of available plugins is published via the frontblock API and downloaded via gitea-releases
|
|
*/
|
|
export class FrontblockAdmin{
|
|
private plugins: Plugin[]
|
|
|
|
private hookToUids:{[hookName:string]:string[]} = {}
|
|
|
|
private express
|
|
private httpServer
|
|
private io = bsock.createServer()
|
|
private wsServer = http.createServer()
|
|
|
|
constructor(){
|
|
if(!('FrontblockAdmin' in kfs)){
|
|
logger.warn('No config file found! Generating one')
|
|
kfs.FrontblockAdmin = { httpPort: 8080 }
|
|
}
|
|
|
|
this.initialize()
|
|
}
|
|
|
|
private async initialize(){
|
|
await this.loadPlugins()
|
|
this.plugins.forEach(plugin => plugin.start())
|
|
this.startWebsocket()
|
|
this.startWebserver()
|
|
}
|
|
|
|
private async loadPlugins(){
|
|
this.plugins = []
|
|
|
|
pluginList.forEach(async (entry:pluginEntry) => {
|
|
|
|
logger.info("installing plugin " + entry.pluginName)
|
|
const info = await manager.installFromNpm(entry.pluginName);
|
|
|
|
logger.info("loading plugin " + info)
|
|
const clazz = manager.require(entry.pluginName);
|
|
|
|
//let obj = new clazz.default(entry.conf)
|
|
//this.plugins.push(obj)
|
|
})
|
|
|
|
}
|
|
|
|
private initApis(socket){
|
|
//Declare own functions
|
|
const rpcInfos:rpcInfo[] = [
|
|
{
|
|
owner: 'Admin',
|
|
name: 'restartWebserver',
|
|
args: 'port',
|
|
info:{
|
|
type:'call',
|
|
fn: (port:number) => { this.restartWebserver(port) }
|
|
}
|
|
},{
|
|
owner: 'Admin',
|
|
name: 'info',
|
|
args: '',
|
|
info:{
|
|
type:'call',
|
|
fn: () => { return rpcInfos }
|
|
}
|
|
}
|
|
]
|
|
|
|
//translate RPCs to socket-bound function metadata
|
|
this.plugins.forEach(plugin => {
|
|
const pluginName = plugin.name
|
|
plugin.exportRPCs().forEach(rpc => {
|
|
const info = this.rpcToRpcInfo(pluginName, rpc)
|
|
rpcInfos.push(info)
|
|
})
|
|
})
|
|
|
|
//Hook up all the functions
|
|
for(const api of rpcInfos){
|
|
switch(api.info.type){
|
|
case 'call':
|
|
socket.hook(api.name, api.info.fn)
|
|
break
|
|
case 'hook':
|
|
const hook = api.info.generator(socket)
|
|
hook.bind(this)
|
|
socket.hook(api.name, hook)
|
|
break
|
|
case 'unhook':
|
|
socket.hook(api.name, api.info.fn)
|
|
break
|
|
}
|
|
}
|
|
|
|
//initialize the lists of open hooks
|
|
rpcInfos
|
|
.filter(rpc => rpc.info.type === "hook")
|
|
.forEach(hook => {
|
|
this.hookToUids[hook.name] = []
|
|
})
|
|
|
|
//On close, unhook open hooks
|
|
socket.on('close', () => {
|
|
logger.info("Client disconnected")
|
|
|
|
rpcInfos.forEach((rpc) => {
|
|
if(this.hookToUids[rpc.name] == null)
|
|
return
|
|
|
|
this.hookToUids[rpc.name].forEach((uid) => {
|
|
if(rpc.info.type === "hook"){
|
|
logger.info("Closing consumer `"+uid+"` owned by `"+rpc.name+"`")
|
|
rpc.info.unhook(uid)
|
|
}
|
|
})
|
|
})
|
|
})
|
|
}
|
|
|
|
private startWebserver(){
|
|
if(this.httpServer != null || this.express != null){
|
|
logger.warn("Webserver is already running")
|
|
return
|
|
}
|
|
|
|
let port:number = kfs.FrontblockAdmin.httpPort
|
|
this.express = express()
|
|
this.express.use(express.static('static'))
|
|
|
|
this.httpServer = http.Server(this.express)
|
|
this.httpServer.listen(port, () => {
|
|
logger.info('Admin panel listening for HTTP on *'+port)
|
|
})
|
|
}
|
|
|
|
private stopWebserver(){
|
|
if(this.httpServer == null || this.express == null){
|
|
logger.warn("Webserver is not running")
|
|
return
|
|
}
|
|
this.httpServer.close()
|
|
this.httpServer = null
|
|
this.express = null
|
|
logger.info("Webserver stopped")
|
|
}
|
|
|
|
private restartWebserver(port:number){
|
|
this.stopWebserver()
|
|
kfs.FrontblockAdmin = { httpPort: port }
|
|
this.startWebserver()
|
|
}
|
|
|
|
private startWebsocket(){
|
|
try{
|
|
this.io.attach(this.wsServer)
|
|
this.io.on('socket', (socket) => {
|
|
logger.info("New Websocket connection on port", socket.port)
|
|
|
|
const handleError = (e: any) => {
|
|
logger.info("Websocket closing", String(e))
|
|
socket.close()
|
|
}
|
|
|
|
socket.on('error', handleError)
|
|
this.initApis(socket)
|
|
})
|
|
logger.info('Admin websocket listening on *20000')
|
|
this.wsServer.listen(20000)
|
|
}catch(e){
|
|
logger.error(String(e))
|
|
}
|
|
}
|
|
|
|
private rpcToRpcInfo(owner:string, rpc:socketioRPC):rpcInfo{
|
|
switch(rpc.type){
|
|
case 'hook':
|
|
let f = this.hookGenerator(rpc)
|
|
return {owner: owner, name: rpc.name, args: this.extractArgs(f(null)), info: { type: 'hook', generator: f, unhook: rpc.unhook } }
|
|
case 'unhook':
|
|
return {owner: owner, name: rpc.name, args: this.extractArgs(rpc.rpc), info: { type: 'unhook', fn: rpc.rpc } }
|
|
case 'call':
|
|
return {owner: owner, name: rpc.name, args: this.extractArgs(rpc.rpc), info: { type: 'call', fn: rpc.rpc } }
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates RPC hooks which support a callback.
|
|
*
|
|
* Note callbacks *need* to accept a singular argument and they have to be the last parameter!
|
|
*/
|
|
hookGenerator = (rpc:socketioRPC) => {
|
|
const argsArr = this.extractArgs(rpc.rpc).split(',')
|
|
argsArr.pop()
|
|
const args = argsArr.join(',')
|
|
|
|
return eval(`(socket) => async (`+args+`) => {
|
|
const res = await rpc.rpc(`+args+(args.length!==0?',':'')+` (x) => {
|
|
socket.call(res.uid, x).catch(e => {
|
|
logger.debug(String(e))
|
|
})
|
|
})
|
|
if(res.uid != null){
|
|
this.hookToUids[rpc.name].push(res.uid)
|
|
}
|
|
return res
|
|
}`)
|
|
}
|
|
|
|
private extractArgs(f:Function):string{
|
|
let fn = String(f)
|
|
let args = fn.substr(0, fn.indexOf(")"))
|
|
args = args.substr(fn.indexOf("(")+1)
|
|
return args
|
|
}
|
|
}
|
|
|
|
(async() => {
|
|
new FrontblockAdmin()
|
|
})() |