Expect Invoker and Fedora build fixes

5 files changed, 507 insertions, 9 deletions

diff --git a/src/uscxml/plugins/invoker/CMakeLists.txt b/src/uscxml/plugins/invoker/CMakeLists.txt
index 6dd78ec..607e64e 100644
--- a/src/uscxml/plugins/invoker/CMakeLists.txt
+++ b/src/uscxml/plugins/invoker/CMakeLists.txt
@@ -95,6 +95,26 @@ else()
 endif()
 
 
+# expect invoker
+
+set(USCXML_INVOKERS "expect ${USCXML_INVOKERS}")
+file(GLOB_RECURSE EXPECT_INVOKER
+	expect/*.cpp
+	expect/*.h
+)
+if (BUILD_AS_PLUGINS)
+	source_group("" FILES EXPECT_INVOKER)
+	add_library(
+		invoker_expect SHARED 
+		${EXPECT_INVOKER}
+		"../Plugins.cpp")
+	target_link_libraries(invoker_expect uscxml)
+	set_target_properties(invoker_expect PROPERTIES FOLDER "Plugin Invoker")
+else()
+	list (APPEND USCXML_FILES ${EXPECT_INVOKER})
+endif()
+
+
 # SQLite3 SQL Invoker
 
 if (SQLITE3_FOUND)
diff --git a/src/uscxml/plugins/invoker/expect/ExpectInvoker.cpp b/src/uscxml/plugins/invoker/expect/ExpectInvoker.cpp
new file mode 100644
index 0000000..c66005f
--- /dev/null
+++ b/src/uscxml/plugins/invoker/expect/ExpectInvoker.cpp
@@ -0,0 +1,359 @@
+/**
+ *  @file
+ *  @author     2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
+ *  @copyright  Simplified BSD
+ *
+ *  @cond
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the FreeBSD license as published by the FreeBSD
+ *  project.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *
+ *  You should have received a copy of the FreeBSD license along with this
+ *  program. If not, see <http://www.opensource.org/licenses/bsd-license>.
+ *  @endcond
+ */
+
+#include "ExpectInvoker.h"
+#include <glog/logging.h>
+
+#ifdef BUILD_AS_PLUGINS
+#include <Pluma/Connector.hpp>
+#endif
+
+#include "uscxml/UUID.h"
+
+#undef USE_TCL_STUBS
+
+namespace uscxml {
+
+#ifdef BUILD_AS_PLUGINS
+PLUMA_CONNECTOR
+bool pluginConnect(pluma::Host& host) {
+	host.add( new ExpectInvokerProvider() );
+	return true;
+}
+#endif
+
+Tcl_Interp* ExpectInvoker::_tcl = NULL;
+
+ExpectInvoker::ExpectInvoker() : _eventQueue(NULL) {
+}
+
+ExpectInvoker::~ExpectInvoker() {
+	_eventQueue->stop();
+	exp_cl
+//	if (_tcl) {
+//		Tcl_DeleteInterp(_tcl);
+//	}
+};
+
+boost::shared_ptr<InvokerImpl> ExpectInvoker::create(InterpreterImpl* interpreter) {
+	boost::shared_ptr<ExpectInvoker> invoker = boost::shared_ptr<ExpectInvoker>(new ExpectInvoker());
+	return invoker;
+}
+
+Data ExpectInvoker::getDataModelVariables() {
+	Data data;
+	return data;
+}
+
+void ExpectInvoker::send(const SendRequest& req) {
+	EventContext* ctx = new EventContext();
+	ctx->sendReq = req;
+	ctx->instance = this;
+	
+//	LOG(ERROR) << "################ " << req;
+	
+	std::string eventId = UUID::getUUID();
+	_eventQueue->addEvent(eventId, ExpectInvoker::send, 0, ctx);
+	
+//	send(ctx, "");
+}
+	
+void ExpectInvoker::send(void *userdata, const std::string event) {
+
+	EventContext* ctx = (EventContext*)userdata;
+	if (!ctx)
+		return;
+	
+	if (!ctx->instance) {
+		delete(ctx);
+		return;
+	}
+
+	const SendRequest& req = ctx->sendReq;
+	
+	if (iequals(req.name, "expect.match")) {
+		int nrCases = req.params.size();
+		struct exp_case *cases = (struct exp_case*)malloc(sizeof(struct exp_case) * (nrCases + 1));
+		memset(cases, 0, sizeof(exp_case) * (nrCases + 1));
+		
+		/**
+		 exp_end: indicates that no more  patterns appear.
+		 exp_glob: indicates that the pattern is a glob-style string pattern.
+		 exp_exact: indicates that the pattern is an exact string.
+		 exp_regexp: indicates that the pattern is a regexp-style string pattern.
+		 exp_compiled: indicates that the pattern is a regexp-style string pattern, and that its compiled form is also provided.
+		 exp_null: indicates that the pattern is a null (for debugging purposes, a string pattern must also follow).
+		*/
+		
+		Event::params_t::const_iterator paramIter = req.params.begin();
+		int index = 0;
+		while (paramIter != req.params.end()) {
+			struct exp_case* expCase = &cases[index];
+			size_t colonPos = paramIter->first.find(":");
+			if (colonPos != std::string::npos) {
+				if (paramIter->first.substr(0, colonPos) == "regex") {
+					expCase->type = exp_regexp;
+				} else if(paramIter->first.substr(0, colonPos) == "glob") {
+					expCase->type = exp_glob;
+				} else if(paramIter->first.substr(0, colonPos) == "exact") {
+					expCase->type = exp_exact;
+				} else {
+					// if we can't make sense of the type
+					expCase->type = exp_exact;
+				}
+			} else {
+				expCase->type = exp_regexp;
+			}
+			
+			expCase->pattern = strdup(paramIter->second.atom.c_str());
+//			LOG(ERROR) << "################ " << expCase->pattern;
+
+			if (expCase->type == exp_regexp) {
+				expCase->re = TclRegComp(expCase->pattern);
+				if (expCase->re == NULL) {
+					LOG(ERROR) << TclGetRegError();
+					expCase->type = exp_null;
+				}
+			}
+			expCase->value = index + 1;
+			paramIter++;
+			index++;
+		}
+		
+		assert(index == nrCases);
+		
+		cases[nrCases].type = exp_end;
+
+		/**
+		 * The functions wait until the output from a process matches one of the
+		 * patterns, a specified time period has passed, or an EOF is seen.
+		 */
+		
+		int rc = 0;
+		// exp_fexpectv won't return on timeout when called in thread
+//		rc = exp_fexpectv(ctx->instance->_cmdFP, cases);
+		rc = exp_expectv(ctx->instance->_cmdFD, cases);
+	
+		if (rc == EXP_EOF) {
+			Event ev;
+			ev.name = "expect.match.eof";
+			ev.data.compound["buffer"] = Data(exp_buffer, Data::VERBATIM);
+			ctx->instance->returnEvent(ev);
+		} else if (rc == EXP_TIMEOUT) {
+			Event ev;
+			ev.name = "expect.match.timeout";
+			ev.data.compound["buffer"] = Data(exp_buffer, Data::VERBATIM);
+			ctx->instance->returnEvent(ev);
+		} else if (rc == EXP_FULLBUFFER) {
+			Event ev;
+			ev.name = "expect.match.fullbuffer";
+			ev.data.compound["buffer"] = Data(exp_buffer, Data::VERBATIM);
+			ctx->instance->returnEvent(ev);
+		} else if (rc > 0) {
+			rc--; // we started at 1
+			paramIter = req.params.begin();
+			while(rc > 0) {
+				if (paramIter == req.params.end())
+					break;
+				paramIter++;
+				rc--;
+			}
+			if (paramIter != req.params.end()) {
+				Event event;
+				
+				size_t colonPos = paramIter->first.find(":");
+				if (colonPos != std::string::npos) {
+					std::string eventName = paramIter->first;
+					event.name = std::string("expect.match.") + eventName.substr(colonPos + 1, eventName.length() - (colonPos + 1));
+					event.data.compound["type"] = Data(paramIter->first.substr(0, colonPos), Data::VERBATIM);
+
+				} else {
+					event.name = std::string("expect.match.") + paramIter->first;
+					event.data.compound["type"] = Data("regex", Data::VERBATIM);
+				}
+				
+				event.data.compound["pattern"] = Data(paramIter->second.atom, Data::VERBATIM);
+				event.data.compound["buffer"] = Data(exp_buffer, Data::VERBATIM);
+				event.data.compound["start"] = Data((int)(exp_match - exp_buffer));
+				event.data.compound["end"] = Data((int)(exp_match_end - exp_buffer));
+				event.data.compound["match"] = Data(std::string(exp_buffer).substr(exp_match - exp_buffer, exp_match_end - exp_match), Data::VERBATIM);
+				ctx->instance->returnEvent(event);
+			} else {
+				// exp_fexpectl returned gibberish
+				assert(false);
+			}
+		} else {
+			// exp_fexpectl returned gibberish
+			assert(false);
+		}
+
+		// free our memory
+		for (int i = 0; i < nrCases; i++) {
+			if (cases[i].pattern != NULL)
+				free(cases[i].pattern);
+			if (cases[i].re != NULL)
+				free(cases[i].re);
+		}
+		free(cases);
+
+	} else if (iequals(req.name, "expect.send")) {
+		std::string toSend = unescape(req.content);
+		ctx->instance->_interpreter->getDataModel().replaceExpressions(toSend);
+		fwrite(toSend.c_str(), toSend.length(), 1, ctx->instance->_cmdFP);
+	}
+		
+	delete(ctx);
+}
+
+void ExpectInvoker::cancel(const std::string sendId) {
+}
+
+void ExpectInvoker::invoke(const InvokeRequest& req) {
+	if (_eventQueue == NULL) {
+		_eventQueue = new DelayedEventQueue();
+		_eventQueue->start();
+	}
+
+	EventContext* ctx = new EventContext();
+	ctx->invokeReq = req;
+	ctx->instance = this;
+
+	//_eventQueue->addEvent(req.sendid, ExpectInvoker::invoke, 0, ctx);
+	invoke(ctx, "");
+	
+}
+	
+void ExpectInvoker::invoke(void *userdata, const std::string event) {
+	EventContext* ctx = (EventContext*)userdata;
+	
+	if (!ctx)
+		return;
+	
+	if (!ctx->instance) {
+		delete(ctx);
+		return;
+	}
+	
+	const InvokeRequest& req = ctx->invokeReq;
+	
+	// moved here for thread local storage
+	if (ctx->instance->_tcl == NULL) {
+	  ctx->instance->_tcl = Tcl_CreateInterp();
+		if (ctx->instance->_tcl) {
+			Tcl_Init(ctx->instance->_tcl);
+			Expect_Init(ctx->instance->_tcl);
+		}
+		ctx->instance->_cmdFP = NULL;
+		
+		bool debug = false;
+		Event::getParam(req.params, "debug", debug);
+		if (debug) {
+			exp_is_debugging = 1;
+		} else {
+			exp_is_debugging = 0;
+		}
+		
+		int timeout = 20;
+		Event::getParam(req.params, "timeout", timeout);
+		exp_timeout = timeout;
+		
+		bool logUser = false;
+		Event::getParam(req.params, "loguser", logUser);
+		if (logUser) {
+			exp_loguser = 1;
+		} else {
+			exp_loguser = 0;
+		}
+		
+		// exp_interactive = 1;
+		exp_logfile = 0;
+		// exp_remove_nulls = 1;
+		// exp_ttyinit = 1;
+		
+	} else {
+//		assert(false);
+	}
+
+	char* cmd = NULL;
+	char** args = NULL;
+	int nrArgs = 0;
+	
+	if (req.params.count("spawn")) {
+		// get command
+		std::string command;
+		Event::getParam(req.params, "spawn", command);
+		cmd = strdup(command.c_str());
+
+		// get arguments
+		nrArgs = req.params.count("argument");
+		args = (char**)malloc(sizeof(char*) * nrArgs + 2);
+		args[0] = strdup(command.c_str());
+
+		size_t index = 1;
+		std::pair<Event::params_t::const_iterator, Event::params_t::const_iterator> argIterRange = req.params.equal_range("argument");
+		Event::params_t::const_iterator argIter = argIterRange.first;
+		while(argIter != argIterRange.second) {
+			args[index] = strdup(argIter->second.atom.c_str());
+			argIter++;
+			index++;
+		}
+		args[index] = (char*)0;
+	} else if(req.params.count("command")) {
+		
+	}
+		
+	// open socket
+	ctx->instance->_cmdFD = exp_spawnv(cmd, args);
+	if (ctx->instance->_cmdFD > 0) {
+		ctx->instance->_cmdFP = fdopen(ctx->instance->_cmdFD, "r+");
+		
+		if (ctx->instance->_cmdFP) {
+			// disable buffering
+			setbuf(ctx->instance->_cmdFP,(char *)0);
+			Event event;
+			event.name = "spawn.success";
+			ctx->instance->returnEvent(event);
+		}
+	}
+	
+	if (ctx->instance->_cmdFP == NULL || ctx->instance->_cmdFD <= 0) {
+		Event event;
+		event.name = "spawn.failed";
+		event.data.compound["cause"] = Data(strerror(errno), Data::VERBATIM);
+		Tcl_Obj *infoObj = Tcl_GetVar2Ex(_tcl, "errorInfo", NULL, TCL_GLOBAL_ONLY);
+		if (infoObj) {
+			event.data.compound["errorInfo"] = Data(Tcl_GetString(infoObj), Data::VERBATIM);
+		}
+
+		ctx->instance->returnEvent(event);
+	}
+
+	if (cmd)
+		free(cmd);
+	
+	if (args) {
+		for (int i = 0; i < nrArgs + 1; i++) {
+			free(args[i]);
+		}
+		free(args);
+	}
+	
+}
+
+}
\ No newline at end of file
diff --git a/src/uscxml/plugins/invoker/expect/ExpectInvoker.h b/src/uscxml/plugins/invoker/expect/ExpectInvoker.h
new file mode 100644
index 0000000..7c9861e
--- /dev/null
+++ b/src/uscxml/plugins/invoker/expect/ExpectInvoker.h
@@ -0,0 +1,79 @@
+/**
+ *  @file
+ *  @author     2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
+ *  @copyright  Simplified BSD
+ *
+ *  @cond
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the FreeBSD license as published by the FreeBSD
+ *  project.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *
+ *  You should have received a copy of the FreeBSD license along with this
+ *  program. If not, see <http://www.opensource.org/licenses/bsd-license>.
+ *  @endcond
+ */
+
+#ifndef EXPECTINVOKER_H_W02590F0
+#define EXPECTINVOKER_H_W02590F0
+
+#include <uscxml/Interpreter.h>
+
+#ifdef BUILD_AS_PLUGINS
+#include "uscxml/plugins/Plugins.h"
+#endif
+
+#include <tcl.h>
+#include <expect_tcl.h>
+#include <expect.h>
+
+namespace uscxml {
+
+class ExpectInvoker : public InvokerImpl {
+public:
+	struct EventContext {
+		InvokeRequest invokeReq;
+		SendRequest sendReq;
+		ExpectInvoker* instance;
+	};
+
+	ExpectInvoker();
+	virtual ~ExpectInvoker();
+	virtual boost::shared_ptr<InvokerImpl> create(InterpreterImpl* interpreter);
+
+	virtual std::set<std::string> getNames() {
+		std::set<std::string> names;
+		names.insert("expect");
+		names.insert("http://uscxml.tk.informatik.tu-darmstadt.de/#expect");
+		return names;
+	}
+
+	virtual Data getDataModelVariables();
+	virtual void send(const SendRequest& req);
+	virtual void cancel(const std::string sendId);
+	virtual void invoke(const InvokeRequest& req);
+
+protected:
+	
+	static void send(void *userdata, const std::string event);
+	static void invoke(void *userdata, const std::string event);
+
+	static Tcl_Interp* _tcl;
+	FILE* _cmdFP;
+	int _cmdFD;
+	
+	DelayedEventQueue* _eventQueue;
+
+};
+
+#ifdef BUILD_AS_PLUGINS
+PLUMA_INHERIT_PROVIDER(ExpectInvoker, InvokerImpl);
+#endif
+
+}
+
+
+#endif /* end of include guard: EXPECTINVOKER_H_W02590F0 */
diff --git a/src/uscxml/plugins/invoker/im/IMInvoker.cpp b/src/uscxml/plugins/invoker/im/IMInvoker.cpp
index 981f2fe..23594f3 100644
--- a/src/uscxml/plugins/invoker/im/IMInvoker.cpp
+++ b/src/uscxml/plugins/invoker/im/IMInvoker.cpp
@@ -572,14 +572,6 @@ Data IMInvoker::purpleValueToData(GValue* value) {
 
 IMInvoker::IMInvoker() {
 	_account = NULL;
-	if (!_eventQueue) {
-		tthread::lock_guard<tthread::mutex> lock(_initMutex);
-		_eventQueue = new DelayedEventQueue();
-		_eventQueue->addEvent("initLibPurple", IMInvoker::initLibPurple, 0, NULL);
-		_eventQueue->start();
-		// make sure to have the shebang initialized when we leave
-		_initCond.wait(_initMutex);
-	}
 }
 
 IMInvoker::~IMInvoker() {
@@ -593,6 +585,16 @@ IMInvoker::~IMInvoker() {
 
 boost::shared_ptr<InvokerImpl> IMInvoker::create(InterpreterImpl* interpreter) {
 	boost::shared_ptr<IMInvoker> invoker = boost::shared_ptr<IMInvoker>(new IMInvoker());
+
+	if (!_eventQueue) {
+		tthread::lock_guard<tthread::mutex> lock(_initMutex);
+		_eventQueue = new DelayedEventQueue();
+		_eventQueue->addEvent("initLibPurple", IMInvoker::initLibPurple, 0, NULL);
+		_eventQueue->start();
+		// make sure to have the shebang initialized when we leave
+		_initCond.wait(_initMutex);
+	}
+
 	invoker->_dataModelVars.compound["plugins"] = _pluginData;
 	return invoker;
 }
diff --git a/src/uscxml/plugins/ioprocessor/basichttp/BasicHTTPIOProcessor.cpp b/src/uscxml/plugins/ioprocessor/basichttp/BasicHTTPIOProcessor.cpp
index 1b3eff0..7a24c79 100644
--- a/src/uscxml/plugins/ioprocessor/basichttp/BasicHTTPIOProcessor.cpp
+++ b/src/uscxml/plugins/ioprocessor/basichttp/BasicHTTPIOProcessor.cpp
@@ -21,6 +21,7 @@
 
 #include "uscxml/plugins/ioprocessor/basichttp/BasicHTTPIOProcessor.h"
 #include "uscxml/Message.h"
+#include "uscxml/DOMUtils.h"
 #include <iostream>
 #include <event2/dns.h>
 #include <event2/buffer.h>
@@ -85,8 +86,26 @@ boost::shared_ptr<IOProcessorImpl> BasicHTTPIOProcessor::create(InterpreterImpl*
 
 Data BasicHTTPIOProcessor::getDataModelVariables() {
 	Data data;
-	assert(_url.length() > 0);
+	
+	// we are not connected!
+	if(_url.length() == 0)
+		return data;
+	
 	data.compound["location"] = Data(_url, Data::VERBATIM);
+
+	URL url(_url);
+	data.compound["host"] = Data(url.host(), Data::VERBATIM);
+	data.compound["port"] = Data(url.port(), Data::VERBATIM);
+	data.compound["path"] = Data(url.path(), Data::VERBATIM);
+	data.compound["scheme"] = Data(url.scheme(), Data::VERBATIM);
+
+	std::vector<std::string> pathComps = url.pathComponents();
+	std::vector<std::string>::const_iterator pathCompIter = pathComps.begin();
+	while(pathCompIter != pathComps.end()) {
+		data.compound["pathComponens"].array.push_back(Data(*pathCompIter, Data::VERBATIM));
+		pathCompIter++;
+	}
+	
 	return data;
 }
 
@@ -94,10 +113,29 @@ bool BasicHTTPIOProcessor::httpRecvRequest(const HTTPServer::Request& req) {
 	Event reqEvent = req;
 	reqEvent.eventType = Event::EXTERNAL;
 
+//	std::cout << req.raw << std::endl;
+	
+	/**
+	 * If a single instance of the parameter '_scxmleventname' is present, the 
+	 * SCXML Processor must use its value as the name of the SCXML event that it 
+	 * raises.
+	 */
+	
 	// this will call the const subscript operator
 	if (req.data["content"]["_scxmleventname"]) {
 		reqEvent.name = req.data["content"]["_scxmleventname"].atom;
 	}
+	if (req.data["content"]["content"]) {
+		reqEvent.content = req.data["content"]["content"].atom;
+	}
+	
+	// check whether we can parse it as XML
+	if (reqEvent.content.length() > 0) {
+		NameSpacingParser parser = NameSpacingParser::fromXML(reqEvent.content);
+		if (!parser.errorsReported()) {
+			reqEvent.dom = parser.getDocument();
+		}
+	}
 
 	/// test532
 	if (reqEvent.name.length() == 0)