nodejs-poolcontroller 7.6.1 → 7.7.0

package/package.json

@@ -1,56 +1,56 @@
-{
-    "name": "nodejs-poolcontroller",
-    "version": "7.6.1",
-    "description": "nodejs-poolController",
-    "main": "app.js",
-    "author": {
-        "name": "Russell Goldin",
-        "name2": "Robert Strouse"
-    },
-    "license": "GNU Affero General Public License v3.0",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/tagyoureit/nodejs-poolController.git"
-    },
-    "scripts": {
-        "start": "npm run build && node dist/app.js",
-        "start:cached": "node dist/app.js",
-        "build": "tsc",
-        "watch": "tsc -w"
-    },
-    "dependencies": {
-        "@influxdata/influxdb-client": "^1.22.0",
-        "eslint-config-promise": "^2.0.2",
-        "express": "^4.17.2",
-        "extend": "^3.0.2",
-        "jszip": "^3.7.1",
-        "mqtt": "^4.3.5",
-        "multer": "^1.4.4",
-        "multicast-dns": "^7.2.4",
-        "node-ssdp": "^4.0.1",
-        "serialport": "^9.2.8",
-        "socket.io": "^4.4.1",
-        "socket.io-client": "^4.4.1",
-        "source-map-support": "^0.5.21",
-        "winston": "^3.5.1"
-    },
-    "devDependencies": {
-        "@types/express": "^4.17.13",
-        "@types/extend": "^3.0.1",
-        "@types/multer": "^1.4.7",
-        "@types/node": "^12.20.43",
-        "@typescript-eslint/eslint-plugin": "^5.11.0",
-        "@typescript-eslint/parser": "^5.11.0",
-        "eslint": "^8.8.0",
-        "eslint-config-defaults": "^9.0.0",
-        "eslint-config-standard": "^16.0.3",
-        "eslint-plugin-import": "^2.25.4",
-        "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-promise": "^6.0.0",
-        "eslint-plugin-standard": "^5.0.0",
-        "grunt": "^1.4.1",
-        "grunt-banner": "^0.6.0",
-        "ts-node": "^10.5.0",
-        "typescript": "^4.5.5"
-    }
-}
+{
+    "name": "nodejs-poolcontroller",
+    "version": "7.7.0",
+    "description": "nodejs-poolController",
+    "main": "app.js",
+    "author": {
+        "name": "Russell Goldin",
+        "name2": "Robert Strouse"
+    },
+    "license": "GNU Affero General Public License v3.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/tagyoureit/nodejs-poolController.git"
+    },
+    "scripts": {
+        "start": "npm run build && node dist/app.js",
+        "start:cached": "node dist/app.js",
+        "build": "tsc",
+        "watch": "tsc -w"
+    },
+    "dependencies": {
+        "@influxdata/influxdb-client": "^1.25.0",
+        "eslint-config-promise": "^2.0.2",
+        "express": "^4.18.1",
+        "extend": "^3.0.2",
+        "jszip": "^3.9.1",
+        "mqtt": "^4.3.7",
+        "multer": "^1.4.4",
+        "multicast-dns": "^7.2.4",
+        "node-ssdp": "^4.0.1",
+        "serialport": "^9.2.8",
+        "socket.io": "^4.5.0",
+        "socket.io-client": "^4.5.0",
+        "source-map-support": "^0.5.21",
+        "winston": "^3.7.2"
+    },
+    "devDependencies": {
+        "@types/express": "^4.17.13",
+        "@types/extend": "^3.0.1",
+        "@types/multer": "^1.4.7",
+        "@types/node": "^12.20.52",
+        "@typescript-eslint/eslint-plugin": "^5.23.0",
+        "@typescript-eslint/parser": "^5.23.0",
+        "eslint": "^8.15.0",
+        "eslint-config-defaults": "^9.0.0",
+        "eslint-config-standard": "^16.0.3",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-promise": "^6.0.0",
+        "eslint-plugin-standard": "^5.0.0",
+        "grunt": "^1.5.3",
+        "grunt-banner": "^0.6.0",
+        "ts-node": "^10.7.0",
+        "typescript": "^4.6.4"
+    }
+}

package/tsconfig.json

@@ -1,25 +1,25 @@
-{
-    "compilerOptions": {
-        "baseUrl": ".",
-       // "paths": { "*": [ "@types/*" ] },
-        "target":"esnext",
-        "module":"commonjs",
-        "noImplicitAny": false,
-        "removeComments": true,
-        "preserveConstEnums": true,
-        "sourceMap": true,
-        "outDir": "dist",
-        "moduleResolution": "node",
-        "allowJs": false,
-        "allowSyntheticDefaultImports": false,
-        "esModuleInterop": false,
-        "jsx": "react"
-    },
-    "include": [
-        "web/**/*",
-        "logger/**/*",
-        "controller/**/*",
-        "config/**/*", 
-        "**/*.ts"
-    ]
-}
+{
+    "compilerOptions": {
+        "baseUrl": ".",
+       // "paths": { "*": [ "@types/*" ] },
+        "target":"esnext",
+        "module":"commonjs",
+        "noImplicitAny": false,
+        "removeComments": true,
+        "preserveConstEnums": true,
+        "sourceMap": true,
+        "outDir": "dist",
+        "moduleResolution": "node",
+        "allowJs": false,
+        "allowSyntheticDefaultImports": false,
+        "esModuleInterop": false,
+        "jsx": "react"
+    },
+    "include": [
+        "web/**/*",
+        "logger/**/*",
+        "controller/**/*",
+        "config/**/*", 
+        "**/*.ts"
+    ]
+}

package/web/Server.ts

@@ -54,6 +54,7 @@ export class WebServer {
     private _servers: ProtoServer[] = [];
     private family = 'IPv4';
     private _autoBackupTimer: NodeJS.Timeout;
+    private _httpPort: number;
     constructor() { }
     public async init() {
         try {
@@ -68,12 +69,15 @@ export class WebServer {
                 switch (s) {
                     case 'http':
                         srv = new HttpServer(s, s);
+                        if (c.enabled !== false) this._httpPort = c.port;
                         break;
                     case 'http2':
                         srv = new Http2Server(s, s);
+                        if (c.enabled !== false) this._httpPort = c.port;
                         break;
                     case 'https':
                         srv = new HttpsServer(s, s);
+                        if (c.enabled !== false) this._httpPort = c.port;
                         break;
                     case 'mdns':
                         srv = new MdnsServer(s, s);
@@ -173,12 +177,9 @@ export class WebServer {
             }
         }
     }
-    public ip() {
-        return typeof this.getInterface() === 'undefined' ? '0.0.0.0' : this.getInterface().address;
-    }
-    public mac() {
-        return typeof this.getInterface() === 'undefined' ? '00:00:00:00' : this.getInterface().mac;
-    }
+    public ip() { return typeof this.getInterface() === 'undefined' ? '0.0.0.0' : this.getInterface().address; }
+    public mac() { return typeof this.getInterface() === 'undefined' ? '00:00:00:00' : this.getInterface().mac; }
+    public httpPort(): number { return this._httpPort }
     public findServer(name: string): ProtoServer { return this._servers.find(elem => elem.name === name); }
     public findServersByType(type: string) { return this._servers.filter(elem => elem.type === type); }
     public findServerByGuid(uuid: string) { return this._servers.find(elem => elem.uuid === uuid); }
@@ -618,42 +619,6 @@ export class HttpServer extends ProtoServer {
             self._sockets = await self.sockServer.fetchSockets();
         });
         sock.on('echo', (msg) => { sock.emit('echo', msg); });
-/*         sock.on('receivePacketRaw', function (incomingPacket: any[]) {
-            //var str = 'Add packet(s) to incoming buffer: ';
-            logger.silly('User request (replay.html) to RECEIVE packet: %s', JSON.stringify(incomingPacket));
-            for (var i = 0; i < incomingPacket.length; i++) {
-                conn.buffer.pushIn(Buffer.from(incomingPacket[i]));
-                // str += JSON.stringify(incomingPacket[i]) + ' ';
-            }
-            //logger.info(str);
-        });
-        sock.on('replayPackets', function (inboundPkts: number[][]) {
-            // used for replay
-            logger.debug(`Received replayPackets: ${inboundPkts}`);
-            inboundPkts.forEach(inbound => {
-                conn.buffer.pushIn(Buffer.from([].concat.apply([], inbound)));
-                // conn.queueInboundMessage([].concat.apply([], inbound));
-            });
-        });
-        sock.on('sendPackets', function (bytesToProcessArr: number[][]) {
-            // takes an input of bytes (src/dest/action/payload) and sends
-            if (!bytesToProcessArr.length) return;
-            logger.silly('User request (replay.html) to SEND packet: %s', JSON.stringify(bytesToProcessArr));
-
-            do {
-                let bytesToProcess: number[] = bytesToProcessArr.shift();
-
-                // todo: logic for chlor packets
-                let out = Outbound.create({
-                    source: bytesToProcess.shift(),
-                    dest: bytesToProcess.shift(),
-                    action: bytesToProcess.shift(),
-                    payload: bytesToProcess.splice(1, bytesToProcess[0])
-                });
-                conn.queueSendMessage(out);
-            } while (bytesToProcessArr.length > 0);
-
-        }); */
         sock.on('sendOutboundMessage', (mdata) => {
             let msg: Outbound = Outbound.create({});
             Object.assign(msg, mdata);
@@ -733,7 +698,7 @@ export class HttpServer extends ProtoServer {
                     res.header('Access-Control-Allow-Methods', 'OPTIONS, GET, POST, PUT, DELETE');
                     if ('OPTIONS' === req.method) { res.sendStatus(200); }
                     else {
-                        if (req.url !== '/device') {
+                        if (req.url !== '/upnp.xml') {
                             logger.info(`[${new Date().toLocaleTimeString()}] ${req.ip} ${req.method} ${req.url} ${typeof req.body === 'undefined' ? '' : JSON.stringify(req.body)}`);
                             logger.logAPI(`{"dir":"in","proto":"api","requestor":"${req.ip}","method":"${req.method}","path":"${req.url}",${typeof req.body === 'undefined' ? '' : `"body":${JSON.stringify(req.body)},`}"ts":"${Timestamp.toISOLocal(new Date())}"}${os.EOL}`);
                         }
@@ -824,7 +789,7 @@ export class HttpsServer extends HttpServer {
                 res.header('Access-Control-Allow-Methods', 'OPTIONS, GET, POST, PUT, DELETE');
                 if ('OPTIONS' === req.method) { res.sendStatus(200); }
                 else {
-                    if (req.url !== '/device') {
+                    if (req.url !== '/upnp.xml') {
                         logger.info(`[${new Date().toLocaleString()}] ${req.ip} ${req.method} ${req.url} ${typeof req.body === 'undefined' ? '' : JSON.stringify(req.body)}`);
                         logger.logAPI(`{"dir":"in","proto":"api","requestor":"${req.ip}","method":"${req.method}","path":"${req.url}",${typeof req.body === 'undefined' ? '' : `"body":${JSON.stringify(req.body)},`}"ts":"${Timestamp.toISOLocal(new Date())}"}${os.EOL}`);
                     }
@@ -874,6 +839,84 @@ export class HttpsServer extends HttpServer {
     }
 }
 export class SsdpServer extends ProtoServer {
+    // Simple service discovery protocol
+    public server: any; //node-ssdp;
+    public deviceUUID: string;
+    public upnpPath: string;
+    public modelName: string;
+    public modelNumber: string;
+    public serialNumber: string;
+    public deviceType = 'urn:schemas-tagyoureit-org:device:PoolController:1';
+    public async init(cfg) {
+        this.uuid = cfg.uuid;
+        if (cfg.enabled) {
+            let self = this;
+            logger.info('Starting up SSDP server');
+            let ver = JSON.parse(fs.readFileSync(path.posix.join(process.cwd(), '/package.json'), 'utf8')).version || '0.0.0';
+            this.deviceUUID = 'uuid:806f52f4-1f35-4e33-9299-' + webApp.mac().replace(/:/g, '');
+            this.serialNumber = webApp.mac();
+            this.modelName = `njsPC v${ver}`;
+            this.modelNumber = `njsPC${ver.replace(/\./g, '-')}`;
+            // todo: should probably check if http/https is enabled at this point
+            let port = config.getSection('web').servers.http.port || 7777;
+            this.upnpPath = 'http://' + webApp.ip() + ':' + port + '/upnp.xml';
+            let SSDP = ssdp.Server;
+            this.server = new SSDP({
+                //customLogger: (...args) => console.log.apply(null, args),
+                logLevel: 'INFO',
+                udn: this.deviceUUID,
+                location: this.upnpPath,
+                sourcePort: 1900
+            });
+            this.server.addUSN('upnp:rootdevice'); // This line will make the server show up in windows.
+            this.server.addUSN(this.deviceType);
+            // start the server
+            this.server.start()
+                .then(function () {
+                    logger.silly('SSDP/UPnP Server started.');
+                    self.isRunning = true;
+                });
+
+            this.server.on('error', function (e) {
+                logger.error('error from SSDP:', e);
+            });
+        }
+    }
+    public deviceXML(): string {
+        let XML = `<?xml version="1.0"?>
+        <root xmlns="urn:schemas-upnp-org:device-1-0">
+            <specVersion>
+                <major>1</major>
+                <minor>0</minor>
+            </specVersion>
+            <device>
+                <deviceType>${this.deviceType}</deviceType>
+                <friendlyName>NodeJS Pool Controller</friendlyName> 
+                <manufacturer>tagyoureit</manufacturer>
+                <manufacturerURL>https://github.com/tagyoureit/nodejs-poolController</manufacturerURL>
+                <presentationURL>http://${webApp.ip()}:${webApp.httpPort()}/state/all</presentationURL>
+                <modelName>${this.modelName}</modelName>
+                <modelNumber>${this.modelNumber}</modelNumber>
+                <modelDescription>An application to control pool equipment.</modelDescription>
+                <serialNumber>${this.serialNumber}</serialNumber>
+                <UDN>${this.deviceUUID}::${this.deviceType}</UDN>
+                <serviceList></serviceList>
+                <deviceList></deviceList>
+            </device>
+        </root>`;
+        return XML;
+    }
+    public async stopAsync() {
+        try {
+            if (typeof this.server !== 'undefined') {
+                this.server.stop();
+                logger.info(`Stopped SSDP server: ${this.name}`);
+            }
+        } catch (err) { logger.error(`Error stopping SSDP server ${err.message}`); }
+    }
+}
+/* RKS DEPRECATED: 05-07-22 - This did not follow the upnp rules so it was not detecting properly.  The entire class above emits the proper xml layout.
+export class SsdpServer1 extends ProtoServer {
     // Simple service discovery protocol
     public server: any; //node-ssdp;
     public async init(cfg) {
@@ -939,6 +982,10 @@ export class SsdpServer extends ProtoServer {
         } catch (err) { logger.error(`Error stopping SSDP server ${err.message}`); }
     }
 }
+*/
+
+
+
 export class MdnsServer extends ProtoServer {
     // Multi-cast DNS server
     public server;
@@ -1102,7 +1149,6 @@ export class HttpInterfaceServer extends ProtoServer {
         catch (err) { }
     }
 }
-
 export class InfluxInterfaceServer extends ProtoServer {
     public bindingsPath: string;
     public bindings: InfluxInterfaceBindings;
@@ -1163,7 +1209,6 @@ export class InfluxInterfaceServer extends ProtoServer {
         }
     }
 }
-
 export class MqttInterfaceServer extends ProtoServer {
     public bindingsPath: string;
     public bindings: HttpInterfaceBindings;
@@ -1450,7 +1495,7 @@ export class REMInterfaceServer extends ProtoServer {
     }
     private isJSONString(s: string): boolean {
         if (typeof s !== 'string') return false;
-        if (typeof s.startsWith('{') || typeof s.startsWith('[')) return true;
+        if (s.startsWith('{') || s.startsWith('[')) return true;
         return false;
     }
     public async getApiService(url: string, data?: any, timeout: number = 3600): Promise<InterfaceServerResponse> {