77-openhab2.js

/*

  openHAB nodes for IBM's Node-Red
  https://github.com/pdmangel/node-red-contrib-openhab2
  (c) 2017, Peter De Mangelaere <peter.demangelaere@gmail.com>

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

*/
var EventSource = require('@joeybaker/eventsource');
var request = require('request');

function getConnectionString(config) {
	var url;

	if ( config.protocol )
		url = config.protocol;
	else
		url = "http";

	url += "://";

	if ( (config.username != undefined) && (config.username.trim().length != 0) )
	{
		url += encodeURIComponent(config.username.trim());

		if ( (config.password != undefined) && (config.password.length != 0) )
		{
			url += ":" + encodeURIComponent(config.password);
		}
		url += "@";
	}
	url +=  config.host;

	if ( (config.port != undefined) && (config.port.trim().length != 0) )
	{
		url += ":" + config.port.trim();
	}

	if ( (config.path != undefined) && (config.path.trim().length != 0) )
	{
		var path = config.path.trim();

		path = path.replace(/^[\/]+/, '');
		path = path.replace(/[\/]+$/, '');

		url += "/" + path;
	}

	return url;
}

module.exports = function(RED) {

	/**
	* ====== httpAdmin ================
	* Enable controller route to static files
	* ===========================================
	*/
	RED.httpAdmin.get('/static/*', function(req, res) {
		var options = {
		  root: __dirname + '/static/',
		  dotfiles: 'deny'
		};
		res.sendFile(req.params[0], options);
	  });


	/**
	* ====== openhab2-controller ================
	* Holds the hostname and port of the
	* openHAB server
	* ===========================================
	*/
	function OpenHABControllerNode(config) {
		RED.nodes.createNode(this, config);

		this.getConfig = function () {
			return config;
		}

		var node = this;

		node.log(JSON.stringify(config));

		// this controller node handles all communication with the configured openhab server


		function getStateOfItems(config) {
			//node.log("getStateOfItems : config = " + JSON.stringify(config));

            var url = getConnectionString(config) + "/rest/items";
			request.get(url, function(error, response, body) {
            	// handle communication errors
        		if ( error ) {
        			node.warn("request error '" + error  + "' on '" + url + "'");
					node.emit('CommunicationError', error);
        		}
        		else if ( response.statusCode == 503 )
        		{
					// openhab not fully ready .... retry after 5 seconds
        			node.warn("response status 503 on '" + url + "' .... retry later");
					node.emit('CommunicationError', response );
					setTimeout(function() {
						getStateOfItems(config);
					}, 5000);
        		}
        		else if ( response.statusCode != 200 ) {
        			node.warn("response error '" + JSON.stringify(response) + "' on '" + url + "'");
					node.emit('CommunicationError', response);
        		}
        		else {
        			// update the registered nodes with item state
    				node.emit('CommunicationStatus', "ON");

		    		var items = JSON.parse(body);

		    		items.forEach(function(item) {
						node.emit(item.name + "/StateEvent", {type: "ItemStateEvent", state: item.state});
		    		});

        		}
           	});

		}

		function startEventSource() {

			// register for all item events

			node.es= new EventSource(getConnectionString(config) + "/rest/events?topics=openhab/items", {});

			// handle the 'onopen' event

			node.es.onopen = function(event) {

				// get the current state of all items
	            getStateOfItems(config);
	       	};

			// handle the 'onmessage' event

	       	node.es.onmessage = function(msg) {
			    //node.log(msg.data);
				try
				{
        			// update the node status with the Item's new state
				    msg = JSON.parse(msg.data);
				    msg.payload = JSON.parse(msg.payload);

				    const itemStart = ("openhab/items/").length;
				    var item = msg.topic.substring(itemStart, msg.topic.indexOf('/',itemStart));

				    node.emit(item + "/RawEvent", msg);
				    node.emit("RawEvent", msg);

				    if ( (msg.type == "ItemStateEvent") || (msg.type == "ItemStateChangedEvent") || (msg.type == "GroupItemStateChangedEvent"))
				    	node.emit(item + "/StateEvent", {type: msg.type, state: msg.payload.value});

				}
				catch(e)
				{
					// report an unexpected error
					node.error("Unexpected Error : " + e)
				}

			};

			// handle the 'onerror' event

	       	node.es.onerror = function(err) {
				if( err.type && (JSON.stringify(err.type) === '{}') )
					return; // ignore

	       		node.warn('ERROR ' +	JSON.stringify(err));
				node.emit('CommunicationError', JSON.stringify(err));


				if ( err.status )
				{
					if ( (err.status == 503) || (err.status == "503") || (err.status == 404) || (err.status == "404") )
						// the EventSource object has given up retrying ... retry reconnecting after 10 seconds

						node.es.close();
						delete node.es;

						node.emit('CommunicationStatus', "OFF");

						setTimeout(function() {
							startEventSource();
						}, 10000);
				}
				else if ( err.type && err.type.code )
				{
					// the EventSource object is retrying to reconnect
				}
				else
				{
					// no clue what the error situation is
				}
			  };

		}

	    //startEventSource();
		// give the system few seconds
		setTimeout(function() {
			startEventSource();
		}, 5000);

		this.control = function(itemname, topic, payload, okCb, errCb) {
			var url;

            if ( topic === "ItemUpdate" )
            {
            	url = getConnectionString(config) + "/rest/items/" + itemname + "/state";
				headers = {"Content-type":"text/plain"};
            	method = request.put;
            }
            else if ( topic === "ItemCommand" )
            {
            	url = getConnectionString(config) + "/rest/items/" + itemname;
				headers = {"Content-type":"text/plain"};
            	method = request.post;
            }
            else
            {
            	url = getConnectionString(config) + "/rest/items/" + itemname;
		    		headers = {};
            	method = request.get;
            }

			method({url: url, body: String(payload), headers: headers}, function(error, response, body) {
        		if ( error )
        		{
					node.emit('CommunicationError', error);
        			errCb("request error '" + error + "' on '" + url + "'");
        		}
        		else if ( Math.floor(response.statusCode / 100) != 2 )
        		{
					node.emit('CommunicationError', response);
        			errCb("response error '" + JSON.stringify(response) + "' on '" + url + "'");
        		}
        		else
        		{
        			okCb(body);
        		}
        	});

		};

		this.on("close", function() {
			node.log('close');
			node.es.close();
			node.emit('CommunicationStatus', "OFF");
		});

	}
    RED.nodes.registerType("openhab2-controller", OpenHABControllerNode);

  // start a web service for enabling the node configuration ui to query for available openHAB items

	RED.httpNode.get("/openhab2/items",function(req, res, next) {
		var config = req.query;
		var url = getConnectionString(config) + '/rest/items';
		request.get(url, function(error, response, body) {
			if ( error ) {
				res.send("request error '" + JSON.stringify(error) + "' on '" + url + "'");
			}
			else if ( response.statusCode != 200 ) {
				res.send("response error '" + JSON.stringify(response) + "' on '" + url + "'");
			}
			else {
				res.send(body);
			}
		});

	});

	/**
	* ====== openhab2-in ========================
	* Handles incoming openhab2 events, injecting
	* json into node-red flows
	* ===========================================
	*/
	function OpenHABIn(config) {
		RED.nodes.createNode(this, config);
		this.name = config.name;
		var node = this;
		var openhabController = RED.nodes.getNode(config.controller);
		var itemName = config.itemname;

		if ( itemName != undefined ) itemName = itemName.trim();

		//node.log('OpenHABIn, config: ' + JSON.stringify(config));


		this.refreshNodeStatus = function() {
			var currentState = node.context().get("currentState");

		    if ( currentState == null )
		        node.status({fill:"yellow", shape: "ring", text: "state:" + currentState});
		    else if ( currentState == "ON" )
		        node.status({fill:"green", shape: "dot", text: "state:" + currentState});
		    else if ( currentState == "OFF" )
		        node.status({fill:"green", shape: "ring", text: "state:" + currentState});
		    else
		        node.status({fill:"blue", shape: "ring", text: "state:" + currentState});
		};

		this.processStateEvent = function(event) {

			var currentState = node.context().get("currentState");

			if ( (event.state != currentState) && (event.state != "null") )
			{
				// update node's context variable
				currentState = event.state;
				node.context().set("currentState", currentState);

				// update node's visual status
				node.refreshNodeStatus();

			    // inject the state in the node-red flow
			    var msgid = RED.util.generateId();
	            node.send([{_msgid:msgid, payload: currentState, item: itemName, event: "StateEvent"}, null]);

			}
		};

		this.processRawEvent = function(event) {
		    // inject the state in the node-red flow
		    var msgid = RED.util.generateId();
            node.send([null, {_msgid:msgid, payload: event, item: itemName, event: "RawEvent"}]);

		};

		node.context().set("currentState", "?");
		openhabController.addListener(itemName + '/RawEvent', node.processRawEvent);
		openhabController.addListener(itemName + '/StateEvent', node.processStateEvent);
		node.refreshNodeStatus();

		/* ===== Node-Red events ===== */
		this.on("input", function(msg) {
			if (msg != null) {

			};
		});
		this.on("close", function() {
			node.log('close');
			openhabController.removeListener(itemName + '/StateEvent', node.processStateEvent);
			openhabController.removeListener(itemName + '/RawEvent', node.processRawEvent);
		});

	}
	//
	RED.nodes.registerType("openhab2-in", OpenHABIn);


	/**
	* ====== openhab2-monitor ===================
	* Monitors connection status and errors of
	* the associated openhab2-controller
	* ===========================================
	*/
	function OpenHABMonitor(config) {
		RED.nodes.createNode(this, config);
		this.name = config.name;
		var node = this;
		var openhabController = RED.nodes.getNode(config.controller);

		this.refreshNodeStatus = function() {
			var commError = node.context().get("CommunicationError");
			var commStatus = node.context().get("CommunicationStatus");

			node.status({
				fill: 	(commError.length == 0 ) ? "green" : "red" ,
				shape: 	(commStatus == "ON" ) ? "dot" : "ring",
				text:	(commError.length != 0) ? commError : commStatus});

		};

		this.processCommStatus = function(status) {

			// update node's context variable

			node.context().set("CommunicationStatus", status);
			if ( status == "ON" )
				node.context().set("CommunicationError", "");

			// update node's visual status
			node.refreshNodeStatus();

		    // inject the state in the node-red flow (channel 1)
		    var msgid = RED.util.generateId();
            node.send([{_msgid:msgid, payload: status, event: "CommunicationStatus"}, null, null]);
		};

		this.processCommError = function(error) {

			// update node's context variable
			node.context().set("CommunicationError", JSON.stringify(error));

			// update node's visual status
			node.refreshNodeStatus();

		    // inject the error in the node-red flow (channel 2)
		    var msgid = RED.util.generateId();
            node.send([null, {_msgid:msgid, payload: error, event: "CommunicationError"}, null]);
		};

		this.processRawEvent = function(event) {
		    // inject the state in the node-red flow (channel 3)
		    var msgid = RED.util.generateId();
            node.send([null, null, {_msgid:msgid, payload: event, event: "RawEvent"}]);

		};

		openhabController.addListener('CommunicationStatus', node.processCommStatus);
		openhabController.addListener('CommunicationError', node.processCommError);
		openhabController.addListener('RawEvent', node.processRawEvent);
		node.context().set("CommunicationError", "");
		node.context().set("CommunicationStatus", "?");
		node.refreshNodeStatus();

		/* ===== Node-Red events ===== */
		this.on("input", function(msg) {
			if (msg != null) {

			};
		});
		this.on("close", function() {
			node.log('close');
			openhabController.removeListener('CommunicationStatus', node.processCommStatus);
			openhabController.removeListener('CommunicationError', node.processCommError);
			openhabController.removeListener('RawEvent', node.processRawEvent);
		});

	}
	//
	RED.nodes.registerType("openhab2-monitor", OpenHABMonitor);


	/**
	* ====== openhab2-out ===================
	* Sends outgoing commands or update from
	* messages received via node-red flows
	* =======================================
	*/
	function OpenHABOut(config) {
		RED.nodes.createNode(this, config);
		this.name = config.name;
		var openhabController = RED.nodes.getNode(config.controller);
		var node = this;

		//node.log('new OpenHABOut, config: ' + JSON.stringify(config));

		// handle incoming node-red message
		this.on("input", function(msg) {

			// if a item/topic/payload is specified in the node's configuration, it overrides the item/topic/payload specified in the message
            var item = (config.itemname && (config.itemname.length != 0)) ? config.itemname : msg.item;
            var topic = (config.topic && (config.topic.length != 0)) ? config.topic : msg.topic;
            var payload = (config.payload && (config.payload.length != 0)) ? config.payload : msg.payload;

            if ( payload != undefined )
			{
	            // execute the appropriate http POST to send the command to openHAB
				// and update the node's status according to the http response

				openhabController.control(item, topic, payload,
									function(body){
										// no body expected for a command or update
										node.status({fill:"green", shape: "dot", text: " "});
										node.send(msg);
									},
									function(err) {
	                					node.status({fill:"red", shape: "ring", text: err});
	                					node.warn(String(err));
									}
				);

			}
			else
			{
				// no payload specified !
                node.status({fill:"red", shape: "ring", text: "no payload specified"});
				node.warn('onInput: no payload specified');
			}

		});
		this.on("close", function() {
			node.log('close');
		});
	}
	//
	RED.nodes.registerType("openhab2-out", OpenHABOut);

	/**
	* ====== openhab2-get ===================
	* Gets the item data when
	* messages received via node-red flows
	* =======================================
	*/
	function OpenHABGet(config) {
		RED.nodes.createNode(this, config);
		this.name = config.name;
		var openhabController = RED.nodes.getNode(config.controller);
		var node = this;

		// handle incoming node-red message
		this.on("input", function(msg) {

            var item = (config.itemname && (config.itemname.length != 0)) ? config.itemname : msg.item;

            openhabController.control(item, null, null,
								function(body){
									// no body expected for a command or update
                					node.status({fill:"green", shape: "dot", text: " "});
                					msg.payload_in = msg.payload;
                					msg.payload = JSON.parse(body);
                					node.send(msg);
								},
								function(err) {
                					node.status({fill:"red", shape: "ring", text: err});
                					node.warn(err);
								}
			);
		});
		this.on("close", function() {
			node.log('close');
		});
	}
	//
	RED.nodes.registerType("openhab2-get", OpenHABGet);

	/**
	* ====== openhab2-events ===================
	* monitors opnHAB events
	* =======================================
	*/
	function OpenHABEvents(config) {
		RED.nodes.createNode(this, config);
		this.name = config.name;
		var openhabController = RED.nodes.getNode(config.controller);
		var node = this;

		function startEventSource() {

			if ( openhabController == null )
			{
			node.error("Invalid controller");
			return;
			}

			// register for all item events


			node.es = new EventSource(getConnectionString(openhabController.getConfig()) + "/rest/events?topics=openhab/*/*", {});

			// handle the 'onopen' event

			node.status({fill:"green", shape: "ring", text: " "});

			node.es.onopen = function(event) {
		        node.status({fill:"green", shape: "dot", text: " "});
	       	};

			// handle the 'onmessage' event

	       	node.es.onmessage = function(msg) {
			    //node.log(msg.data);
				try
				{
        			// update the node status with the Item's new state
				    msg = JSON.parse(msg.data);
				    if ( msg.payload && (msg.payload.constructor == String)  )
				    	msg.payload = JSON.parse(msg.payload);
				    node.send(msg);
				}
				catch(e)
				{
					// report an unexpected error
					node.error("Unexpected Error : " + e)
			        node.status({fill:"red", shape: "dot", text: "Unexpected Error : " + e});
				}

			};

			// handle the 'onerror' event

	       	node.es.onerror = function(err) {
				if( err.type && (JSON.stringify(err.type) === '{}') )
					return; // ignore

	       		node.warn('ERROR ' +	JSON.stringify(err));
		        node.status({fill:"red", shape: "dot", text: 'CommunicationError ' + JSON.stringify(err)});


				if ( err.status )
				{
					if ( (err.status == 503) || (err.status == "503") || (err.status == 404) || (err.status == "404") )
						// the EventSource object has given up retrying ... retry reconnecting after 10 seconds

						node.es.close();
						delete node.es;

				        node.status({fill:"red", shape: "dot", text: 'CommunicationStatus OFF'});

						setTimeout(function() {
							startEventSource();
						}, 10000);
				}
				else if ( err.type && err.type.code )
				{
					// the EventSource object is retrying to reconnect
				}
				else
				{
					// no clue what the error situation is
				}
			  };

		}

	    //startEventSource();
		// give the system few seconds
		setTimeout(function() {
			startEventSource();
		}, 5000);

		this.on("close", function() {
			node.log('close');
			node.es.close();
	        node.status({fill:"red", shape: "dot", text: 'CommunicationStatus OFF'});

		});

	}
	//
	RED.nodes.registerType("openhab2-events", OpenHABEvents);
}