@frangoteam/fuxa-min 1.1.19

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2021 frangoteam 4frango@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+![fuxa logo](/client/src/favicon.ico) 
+# FUXA
+FUXA is a web-based Process Visualization (SCADA/HMI/Dashboard) software. With FUXA you can create modern process visualizations with individual designs for your machines and real-time data display.
+
+![fuxa editor](/screenshot/fuxa-editor.png) 
+
+![fuxa ani](/screenshot/fuxa-ani.gif)
+
+![fuxa action](/screenshot/feature-action-move.gif)
+
+## Features
+- Devices connectivity with Modbus RTU/TCP, OPC-UA, BACnet IP, MQTT, WebAPI, Ethernet/IP (Allen Bradley)
+- SCADA/HMI Web-Editor - Engineering and Design completely web-based
+- Cross-Platform Full-Stack - Backend with NodeJs and Frontend with Web technologies (HTML5, CSS, Javascript, Angular, SVG)
+
+## Live Demo
+Here is a [live demo](https://frangoteam.github.io) example of FUXA editor.
+
+## Installing and Running
+FUXA is developed with NodeJS (backend) and Angular (frontend).
+
+**WARNING** You need to have installed [Node](https://nodejs.org/en/about/previous-releases) Version 14 || 16 || 18
+
+Install from [NPM](https://www.npmjs.com/package/@frangoteam/fuxa-sim)
+```
+npm install -g --unsafe-perm @frangoteam/fuxa-sim
+fuxa
+```
+
+Open up a browser (better Chrome) and navigate to http://localhost:1881
+
+## Usage
+Look the guide in [wiki](https://github.com/frangoteam/FUXA/wiki) pages
+
+## Let us know!
+We’d be really happy if you send us your own shapes in order to collect a library to share it with others. Just send an email to 4frango@gmail.com and do let us know if you have any questions or suggestions regarding our work.
+
+## <a href="https://discord.gg/WZhxz9uHh4" target="_blank" > <img src="https://skillicons.dev/icons?i=discord" alt=""></a>
+
+## License
+MIT.

package/_images/Pipes/P1.svg

@@ -0,0 +1,39 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"[]><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="64px" height="64px" viewBox="0 0 98.043 112.5" enable-background="new 0 0 98.043 112.5" xml:space="preserve">
+
+<g id="Group_30_Deg_Pipe">
+<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="5.4983" y1="69.9102" x2="96.4444" y2="53.8739">
+	<stop offset="0.01" style="stop-color:#646566" />
+	<stop offset="0.49" style="stop-color:#CCCCCC" />
+	<stop offset="1" style="stop-color:#646566" />
+</linearGradient>
+<path fill="url(#SVGID_1_)" d="M19.83,112.388l-0.25-39.671L0.098,39.284L67.983,0.112c0,0,23.453,37.924,25.948,46.158  s4.014,13.972,4.014,17.964c0,3.991,0,48.153,0,48.153H19.83z" />
+<linearGradient id="SVGID_2_" gradientUnits="userSpaceOnUse" x1="81.7634" y1="71.0283" x2="81.7634" y2="-7.6465" gradientTransform="matrix(0 1 1 0 27.3308 6.6702)">
+	<stop offset="0.01" style="stop-color:#646566" />
+	<stop offset="0.16" style="stop-color:#909091" />
+	<stop offset="0.49" style="stop-color:#E0E0E0" />
+	<stop offset="1" style="stop-color:#646566" />
+</linearGradient>
+<path fill="url(#SVGID_2_)" d="M98.359,68.311v44.023H19.798l-0.113-47.802L98.359,68.311z" />
+<linearGradient id="SVGID_3_" gradientUnits="userSpaceOnUse" x1="10.3582" y1="51.5098" x2="50.0603" y2="-17.2564" gradientTransform="matrix(0 1 1 0 27.3308 6.6702)">
+	<stop offset="0.01" style="stop-color:#646566" />
+	<stop offset="0.16" style="stop-color:#909091" />
+	<stop offset="0.49" style="stop-color:#E0E0E0" />
+	<stop offset="1" style="stop-color:#646566" />
+</linearGradient>
+<path fill="url(#SVGID_3_)" d="M68.191,0l19.643,32.604L20.262,74.115L0,39.28L68.191,0z" />
+<linearGradient id="SVGID_4_" gradientUnits="userSpaceOnUse" x1="34.9104" y1="69.6563" x2="49.3619" y2="-8.1895" gradientTransform="matrix(0.2501 0.9682 0.9682 -0.2501 16.0898 24.9472)">
+	<stop offset="0.01" style="stop-color:#646566" />
+	<stop offset="0.16" style="stop-color:#909091" />
+	<stop offset="0.49" style="stop-color:#E0E0E0" />
+	<stop offset="1" style="stop-color:#646566" />
+</linearGradient>
+<path fill="url(#SVGID_4_)" d="M19.684,73.024l67.793-41.096c0,0,3.701,6.927,4.743,9.326c1.063,2.444,3.646,10.021,3.646,10.021  L19.684,73.024z" />
+<linearGradient id="SVGID_5_" gradientUnits="userSpaceOnUse" x1="53.1277" y1="71.4404" x2="61.4217" y2="-7.6076" gradientTransform="matrix(0.0176 0.9998 0.9998 -0.0176 25.7504 7.737)">
+	<stop offset="0.01" style="stop-color:#646566" />
+	<stop offset="0.17" style="stop-color:#8F8F90" />
+	<stop offset="0.49" style="stop-color:#E0E0E0" />
+	<stop offset="1" style="stop-color:#646566" />
+</linearGradient>
+<path fill="url(#SVGID_5_)" d="M19.684,73.024l75.908-22.709c0,0,2.418,8.415,2.767,11.304c0.226,1.871,0,7.538,0,7.538  L19.684,73.024z" />
+</g>
+</svg>

package/_images/Tanks/Fl.svg

@@ -0,0 +1,7 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"[]><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="64px" height="64px" viewBox="0 0 80.295 112.5" enable-background="new 0 0 80.295 112.5" xml:space="preserve">
+<g id="Group_TankBody">
+<path fill="#C0C0C0" d="M80.292,13.889C80.292,6.218,62.319,0,40.147,0C17.976,0,0.002,6.218,0.002,13.889H0.001v66.526  l22.41,32.085h35.36l22.522-32.085V13.889H80.292z" />
+<path fill="none" stroke="#4C4C4C" stroke-width="0.25" d="M0.113,13.063h79.955" />
+<path fill="none" stroke="#4C4C4C" stroke-width="0.25" d="M0.113,80.18h79.955" />
+</g>
+</svg>

package/api/alarms/index.js

@@ -0,0 +1,132 @@
+/**
+ * 'api/alarms': Alarms API to GET/POST alarms data
+ */
+
+var express = require("express");
+const authJwt = require('../jwt-helper');
+var runtime;
+var secureFnc;
+var checkGroupsFnc;
+
+module.exports = {
+    init: function (_runtime, _secureFnc, _checkGroupsFnc) {
+        runtime = _runtime;
+        secureFnc = _secureFnc;
+        checkGroupsFnc = _checkGroupsFnc;
+    },
+    app: function() {
+        var alarmsApp = express();
+        alarmsApp.use(function(req, res, next) {
+            if (!runtime.project) {
+                res.status(404).end();
+            } else {
+                next();
+            }
+        });
+
+        /**
+         * GET current Alarms 
+         * Take from alarms storage and reply 
+         */
+        alarmsApp.get("/api/alarms", secureFnc, function(req, res) {
+            var groups = checkGroupsFnc(req);			
+			 if (res.statusCode === 403) {
+                runtime.logger.error("api get alarms: Tocken Expired");
+            } else {	
+                try {
+                    var result = runtime.alarmsMgr.getAlarmsValues(req.query, groups);
+                    // res.header("Access-Control-Allow-Origin", "*");
+                    // res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
+                    if (result) {
+                        res.json(result);
+                    } else {
+                        res.end();
+                    }
+                } catch (err) {
+                    if (err.code) {
+                        res.status(400).json({error:err.code, message: err.message});
+                    } else {
+                        res.status(400).json({error:"unexpected_error", message:err.toString()});
+                    }
+                    runtime.logger.error("api get alarms: " + err.message);
+                }       
+			}			
+        });
+
+                /**
+         * GET current Alarms 
+         * Take from alarms storage and reply 
+         */
+        alarmsApp.get("/api/alarmsHistory", secureFnc, function(req, res) {
+            var groups = checkGroupsFnc(req);	
+			if (res.statusCode === 403) {
+                runtime.logger.error("api get alarms: Tocken Expired");
+            } else {	
+                runtime.alarmsMgr.getAlarmsHistory(req.query, groups).then(result => {
+                    // res.header("Access-Control-Allow-Origin", "*");
+                    // res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
+                    if (result) {
+                        res.json(result);
+                    } else {
+                        res.end();
+                    }
+                }).catch(function(err) {
+                    if (err.code) {
+                        res.status(400).json({error:err.code, message: err.message});
+                    } else {
+                        res.status(400).json({error:"unexpected_error", message:err.toString()});
+                    }
+                    runtime.logger.error("api get alarms: " + err.message);
+                });    
+			}            
+        });
+
+        /**
+         * POST Alarm ACK
+         * Set alarm ack
+         */
+        alarmsApp.post("/api/alarmack", secureFnc, function(req, res, next) {
+            var groups = checkGroupsFnc(req);			
+			 if (res.statusCode === 403) {
+                runtime.logger.error("api post alarms: Tocken Expired");
+            } else {		
+                runtime.alarmsMgr.setAlarmAck(req.body.params, req.userId, groups).then(function(data) {
+                    res.end();
+                }).catch(function(err) {
+                    if (err.code) {
+                        res.status(err.code).json({error:err.code, message: err.message});
+                    } else {
+                        res.status(400).json({error:"unexpected_error", message:err.toString()});
+                    }
+                    runtime.logger.error("api post alarm-ack: " + err.message);
+                });    
+		  }            
+        });
+
+        /**
+         * POST Alarms clear
+         */
+        alarmsApp.post("/api/alarmsClear", secureFnc, function(req, res, next) {
+            var groups = checkGroupsFnc(req);
+			 if (res.statusCode === 403) {
+                runtime.logger.error("api post alarms: Tocken Expired");
+            } else if (authJwt.adminGroups.indexOf(groups) === -1 ) {
+                res.status(401).json({error:"unauthorized_error", message: "Unauthorized!"});
+                runtime.logger.error("api post alarms: Unauthorized");
+            } else {
+            runtime.alarmsMgr.clearAlarms(req.body.params).then(function() {
+                runtime.alarmsMgr.reset();
+                res.end();
+            }).catch(function(err) {
+                if (err.code) {
+                    res.status(400).json({error:err.code, message: err.message});
+                } else {
+                    res.status(400).json({error:"unexpected_error", message:err.toString()});
+                }
+                runtime.logger.error("api post alarms-clear: " + err.message);
+            });      
+		  }			
+        });
+        return alarmsApp;
+    }
+}

package/api/auth/index.js

@@ -0,0 +1,71 @@
+/**
+ * 'api/auth': Authentication API to Sign In/Out users
+ */
+
+var express = require('express');
+const bcrypt = require('bcryptjs');
+const jwt = require('jsonwebtoken');
+const authJwt = require('../jwt-helper');
+
+var runtime;
+var secretCode;
+var tokenExpiresIn;
+
+module.exports = {
+    init: function (_runtime, _secretCode, _tokenExpires) {
+        runtime = _runtime;
+        secretCode = _secretCode;
+        tokenExpiresIn = _tokenExpires;
+    },
+    app: function () {
+        var authApp = express();
+        authApp.use(function (req, res, next) {
+            if (!runtime.project) {
+                res.status(404).end();
+            } else {
+                next();
+            }
+        });
+
+        /**
+         * POST SignIn
+         * Sign In with User credentials
+         */
+        authApp.post('/api/signin', function (req, res, next) {
+            runtime.users.findOne(req.body).then(function (userInfo) {
+                if (userInfo && userInfo.length && userInfo[0].password) {
+                    if (bcrypt.compareSync(req.body.password, userInfo[0].password)) {
+                        const token = jwt.sign({ id: userInfo[0].username, groups: userInfo[0].groups }, secretCode, { expiresIn: tokenExpiresIn });//'1h' });
+                        res.json({
+                            status: 'success',
+                            message: 'user found!!!',
+                            data: {
+                                username: userInfo[0].username,
+                                fullname: userInfo[0].fullname,
+                                groups: userInfo[0].groups,
+                                info: userInfo[0].info,
+                                token: token
+                            }
+                        });
+                        runtime.logger.info('api-signin: ' + userInfo[0].username + ' ' + userInfo[0].fullname + ' ' + userInfo[0].groups);
+                    } else {
+                        res.status(401).json({ status: 'error', message: 'Invalid email/password!!!', data: null });
+                        runtime.logger.error('api post signin: Invalid email/password!!!');
+                    }
+                } else {
+                    res.status(404).end();
+                    runtime.logger.error('api post signin: Not Found!');
+                }
+            }).catch(function (err) {
+                if (err.code) {
+                    res.status(400).json({error:err.code, message: err.message});
+                } else {
+                    res.status(400).json({error:'unexpected_error', message:err.toString()});
+                }
+                runtime.logger.error('api post signin: ' + err.message);
+            });
+        });
+
+        return authApp;
+    }
+}

package/api/command/index.js

@@ -0,0 +1,187 @@
+/**
+ * 'api/command': Command API to process command like build Report
+ */
+
+var express = require("express");
+const authJwt = require('../jwt-helper');
+const fs = require('fs');
+const path = require('path');
+var runtime;
+var secureFnc;
+var checkGroupsFnc;
+
+module.exports = {
+    init: function (_runtime, _secureFnc, _checkGroupsFnc) {
+        runtime = _runtime;
+        secureFnc = _secureFnc;
+        checkGroupsFnc = _checkGroupsFnc;
+    },
+    app: function () {
+        var commandApp = express();
+        commandApp.use(function (req, res, next) {
+            if (!runtime.project) {
+                res.status(404).end();
+            } else {
+                next();
+            }
+        });
+
+        /**
+         * POST build report
+         */
+         commandApp.post("/api/command", secureFnc, function (req, res, next) {
+            var groups = checkGroupsFnc(req);
+            if (res.statusCode === 403) {
+                runtime.logger.error("api post command: Tocken Expired");
+            } else if (authJwt.adminGroups.indexOf(groups) === -1 ) {
+                res.status(401).json({error:"unauthorized_error", message: "Unauthorized!"});
+                runtime.logger.error("api post command: Unauthorized");
+            } else {
+                try {
+                    if (req.body.params.cmd === CommanTypeEnum.reportBuild) {
+                        if (runtime.jobsMgr.forceReport(req.body.params.report)) {
+                            res.end();
+                        } else {
+                            res.status(400).json({ error: "not_found", message: 'report not found!'});
+                            runtime.logger.error("api post buildreport: " + 'report not found!');
+                        }
+                    }
+                } catch (error) {
+                    res.status(400).json({ error: "error", message: error});
+                    runtime.logger.error("api post buildreport: " + error);
+                }
+            }
+        });
+
+        /**
+         * GET download
+         */
+        commandApp.get('/api/download', secureFnc, function(req, res){
+            var groups = checkGroupsFnc(req);
+            if (res.statusCode === 403) {
+                runtime.logger.error("api post command: Tocken Expired");
+            } else if (authJwt.adminGroups.indexOf(groups) === -1 ) {
+                res.status(401).json({error:"unauthorized_error", message: "Unauthorized!"});
+                runtime.logger.error("api post command: Unauthorized");
+            } else {
+                if (req.query.cmd === CommanTypeEnum.reportDownload) {
+                    try {
+                        const fileName = req.query.name.replace(new RegExp('../', 'g'), '');
+                        var reportPath = path.join(runtime.settings.reportsDir, fileName);
+                        if (!fs.existsSync(reportPath)) {
+                            reportPath = path.join(process.cwd(), runtime.settings.reportsDir, fileName);
+                        }
+                        if (fs.existsSync(reportPath)) {
+                            res.sendFile(reportPath, (err) => {
+                                if (err) {
+                                    runtime.logger.error("api get download: " + err);
+                                }
+                            });
+                        } else {
+                            res.status(400).json({ error: "not_found", message: 'report not found!'});
+                            runtime.logger.error("api get download: " + 'report not found!');
+                        }
+                    } catch (error) {
+                        res.status(400).json({ error: 'error', message: error});
+                        runtime.logger.error("api get download: " + error);
+                    }
+                } else {
+                    res.status(400).json({ error: "not_found", message: 'command not found!'});
+                }
+            }
+        });
+
+        /**
+         * GET get tags values
+         */
+        commandApp.get("/api/getTagValue", secureFnc, async function (req, res, next) {
+            var groups = checkGroupsFnc(req);
+            if (res.statusCode === 403) {
+                runtime.logger.error("api get getTagValue: Tocken Expired");
+            } else if (authJwt.adminGroups.indexOf(groups) === -1 ) {
+                res.status(401).json({error:"unauthorized_error", message: "Unauthorized!"});
+                runtime.logger.error("api get getTagValue: Unauthorized");
+            } else {
+                try {
+                    var tagsIds = JSON.parse(req.query.ids);
+                    if (tagsIds) {
+                        var errors = '';
+                        var result = [];
+                        for (const tagId of tagsIds) {
+                            try {
+                                const value = runtime.devices.getTagValue(tagId, true);
+                                if (value) {
+                                    result.push(value);
+                                } else {
+                                    result.push({id: tagId, value: null});
+                                    errors += `${tagId}; `;
+                                }
+                            } catch (err) {
+                                errors += `${tagId}: ${err}`;
+                            }
+                        }
+                        if (errors) {
+                            runtime.logger.error("api get getTagValue: " + 'id not found!' + errors);
+                        }
+                        res.json(result);
+                    } else {
+                        res.status(400).json({ error: "not_found", message: 'tag id not found!'});
+                        runtime.logger.error("api get getTagValue: " + 'id not found!');
+                    }
+                } catch (error) {
+                    res.status(400).json({ error: "error", message: error});
+                    runtime.logger.error("api get getTagValue: " + error);
+                }                
+            }            
+        });
+
+        /**
+         * POST set tags values
+         */
+        commandApp.post("/api/setTagValue", secureFnc, async function (req, res, next) {
+            var groups = checkGroupsFnc(req);
+            if (res.statusCode === 403) {
+                runtime.logger.error("api post setTagValue: Tocken Expired");
+            } else if (authJwt.adminGroups.indexOf(groups) === -1 ) {
+                res.status(401).json({error:"unauthorized_error", message: "Unauthorized!"});
+                runtime.logger.error("api post setTagValue: Unauthorized");
+            } else {
+                try {
+                    if (req.body.tags) {
+                        var errors = '';
+                        for (const tag of req.body.tags) {
+                            try {
+                                if (!runtime.devices.setTagValue(tag.id, tag.value)) {
+                                    errors += `${tag.id}; `
+                                }
+                            } catch (err) {
+                                errors += `${tag.id}: ${err}`;
+                            }
+                        }
+                        if (errors) {
+                            res.status(400).json({ error: "not_found", message: 'tag id not found: ' + errors});
+                            runtime.logger.error("api post setTagValue: " + 'id not found!' + errors);
+                        } else {
+                            res.end();
+                        }
+                    } else {
+                        res.status(400).json({ error: "not_found", message: 'tag id not found!'});
+                        runtime.logger.error("api post setTagValue: " + 'id not found!');
+                    }
+                } catch (error) {
+                    res.status(400).json({ error: "error", message: error});
+                    runtime.logger.error("api post setTagValue: " + error);
+                }
+            }
+        });
+
+        return commandApp;
+    }
+}
+
+
+const CommanTypeEnum = {
+    reportBuild: 'REPORT-BUILD',
+    reportDelete: 'REPORT-DELETE',
+    reportDownload: 'REPORT-DOWNLOAD'
+};

package/api/daq/index.js

@@ -0,0 +1,79 @@
+/**
+ * 'api/daq': DAQ API to GET/POST storage daq data
+ */
+
+var express = require("express");
+const authJwt = require('../jwt-helper');
+
+var runtime;
+var secureFnc;
+var checkGroupsFnc;
+
+module.exports = {
+    init: function (_runtime, _secureFnc, _checkGroupsFnc) {
+        runtime = _runtime;
+        secureFnc = _secureFnc;
+        checkGroupsFnc = _checkGroupsFnc;
+    },
+    app: function () {
+        var daqApp = express();
+        daqApp.use(function (req, res, next) {
+            if (!runtime.project) {
+                res.status(404).end();
+            } else {
+                next();
+            }
+        });
+        
+        /**
+         * GET daq data
+         * Take from daq storage data and reply 
+         */
+         daqApp.get("/api/daq", secureFnc, function(req, res) {
+            try {
+                if (req.query && req.query.query) {
+                    var query = JSON.parse(req.query.query);
+                    var dbfncs = [];
+                    for (let i = 0; i < query.sids.length; i++) {
+                        if (query.to === query.from) {  // current values
+                            dbfncs.push([runtime.devices.getTagValue(query.sids[i], true)]);
+                        } else {                        // from history
+                            dbfncs.push(runtime.daqStorage.getNodeValues(query.sids[i], query.from, query.to));
+                        }
+                    }
+                    if (query.to === query.from) {  // current values
+                        res.json(dbfncs);
+                    } else {
+                        Promise.all(dbfncs).then(values => {
+                            if (values) {
+                                res.json(values);
+                            } else {
+                                res.status(404).end();
+                                runtime.logger.error("api get daq: Not Found!");
+                            }
+                        }, reason => {
+                            if (reason && reason.stack) {
+                                runtime.logger.error(`api get daq: Not Found!: ${reason.stack}`);
+                                res.status(400).json({error:"unexpected_error", message: reason.stack});
+                            } else {
+                                runtime.logger.error(`api get daq: Not Found!: ${reason}`);
+                                res.status(400).json({error:"unexpected_error", message: reason});
+                            }
+                        });
+                    }
+                } else {
+                    res.status(404).end();
+                    runtime.logger.error("api get daq: Not Found!");
+                }
+            } catch (err) {
+                if (err && err.code) {
+                    res.status(400).json({error:err.code, message: err.message});
+                } else {
+                    res.status(400).json({error:"unexpected_error", message:err.toString()});
+                }
+                runtime.logger.error("api get daq: " + err.message);
+            }
+        });
+        return daqApp;
+    }
+}