path: root/src/uscxml/plugins/datamodel/lua/LuaDataModel.cpp

/**
 *  @file
 *  @author     2012-2014 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 "uscxml/Common.h"
#include "uscxml/util/URL.h"
#include "uscxml/util/String.h"

#include "LuaDataModel.h"

// disable forcing to bool performance warning
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4800)
#endif

#include "LuaBridge.h"

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#include "uscxml/messages/Event.h"

#ifndef NO_XERCESC
#include "uscxml/util/DOM.h"
#endif

#include "uscxml/interpreter/Logging.h"
#include <boost/algorithm/string.hpp>

//#include "LuaDOM.cpp.inc" // TODO: activate XercesC bindings for test 530

#ifdef BUILD_AS_PLUGINS
#include <Pluma/Connector.hpp>
#endif

//static int luaInspect(lua_State * l) {
//	return 0;
//}

//bool _luaHasXMLParser = false;

using namespace XERCESC_NS;

#ifndef NO_XERCESC
#include "LuaDOM.cpp.inc"
#else
#include "LuaEvent.cpp.inc"
#endif
    
namespace uscxml {
    
#ifdef BUILD_AS_PLUGINS
    PLUMA_CONNECTOR
    bool pluginConnect(pluma::Host& host) {
        host.add( new LuaDataModelProvider() );
        return true;
    }
#endif
  
static int luaEval(lua_State* luaState, const std::string& expr) {
	int preStack = lua_gettop(luaState);
	int error = luaL_loadstring(luaState, expr.c_str()) || lua_pcall(luaState, 0, LUA_MULTRET, 0);
	if (error) {
		std::string errMsg = lua_tostring(luaState, -1);
		lua_pop(luaState, 1);  /* pop error message from the stack */
		ERROR_EXECUTION_THROW(errMsg);
	}
	int postStack = lua_gettop(luaState);
	return postStack - preStack;
}

static Data getLuaAsData(lua_State* _luaState, const luabridge::LuaRef& lua) {
	Data data;
	if (lua.isFunction()) {
		// we are creating __tmpFunc
		// then it will be assigned to data variable
		luabridge::setGlobal(_luaState, lua, "__tmpFunc");

		data.atom = "__tmpFunc";
		data.type = Data::INTERPRETED;
	} else if(lua.isLightUserdata() || lua.isUserdata()) {
#ifndef NO_XERCESC
        int err = SWIG_Lua_ConvertPtr(_luaState, 0, (void**)&(data.node), SWIGTYPE_p_XERCES_CPP_NAMESPACE__DOMNode, SWIG_POINTER_DISOWN);
        if (err == SWIG_ERROR)
            data.node = NULL;
#endif
        
    } else if(lua.isThread()) {
		// not sure what to do
	} else if(lua.type() == LUA_TBOOLEAN) {
		// why is there no isBoolean in luabridge?
		if (lua) {
			data.atom = "true";
		} else {
			data.atom = "false";
		}
		data.type = Data::INTERPRETED;
	} else if(lua.isNil()) {
		data.atom = "nil";
		data.type = Data::INTERPRETED;
	} else if(lua.isNumber()) {
		data.atom = toStr(lua.cast<double>());
		data.type = Data::INTERPRETED;
	} else if(lua.isString()) {
		data.atom = lua.cast<std::string>();
		data.type = Data::VERBATIM;
    } else if(lua.isTable()) {
		// check whether it is to be interpreted as a map or an array
		bool isArray = true;
		std::map<std::string, luabridge::LuaRef> luaItems;
		for (luabridge::Iterator iter (lua); !iter.isNil(); ++iter) {
			luabridge::LuaRef luaKey = iter.key();
			luabridge::LuaRef luaVal = *iter;

			if (!luaKey.isNumber() || luaKey.cast<long>() <= 0)
				isArray = false;
			// this will implicitly sort the items
			luaItems.insert(std::make_pair(luaKey.cast<std::string>(), luaVal));
		}

		size_t lastIndex = 0;
		for (auto item : luaItems) {
			if (isArray) {
				// all indices are numeric -> array
				size_t currIndex = strTo<size_t>(item.first);
				while (currIndex > lastIndex + 1) {
					data.array.push_back(Data("nil", Data::INTERPRETED));
					lastIndex++;
				}
				data.array.push_back(getLuaAsData(_luaState, item.second));
				lastIndex++;
			} else {
				// there are some non-numeric indices -> map
				data.compound[item.first] = getLuaAsData(_luaState, item.second);

			}
		}
	}
	return data;
}

static luabridge::LuaRef getDataAsLua(lua_State* _luaState, const Data& data) {
	luabridge::LuaRef luaData (_luaState);

	if (data.node) {
#ifndef NO_XERCESC
        SWIG_Lua_NewPointerObj(_luaState, data.node, SWIGTYPE_p_XERCES_CPP_NAMESPACE__DOMNode, SWIG_POINTER_DISOWN);
        luaData = luabridge::LuaRef::fromStack(_luaState, 1);
        return luaData;
#else
        ERROR_EXECUTION_THROW("No DOM support in Lua datamodel");
#endif
    }
	if (data.compound.size() > 0) {
		luaData = luabridge::newTable(_luaState);
		std::map<std::string, Data>::const_iterator compoundIter = data.compound.begin();
		while(compoundIter != data.compound.end()) {
			if (isInteger(compoundIter->first.c_str(), 10) && strTo<long>(compoundIter->first) > 0) {
				// it makes a difference whether we pass a numeric string or a proper number!
				// MSVC throws assertion with LuaBridge for size_t instead of int
				luaData[strTo<long>(compoundIter->first)] = getDataAsLua(_luaState, compoundIter->second);
			} else {
				luaData[compoundIter->first] = getDataAsLua(_luaState, compoundIter->second);
			}
			compoundIter++;
		}
//		luaData["inspect"] = luaInspect;
		return luaData;
	}
	if (data.array.size() > 0) {
		luaData = luabridge::newTable(_luaState);
		std::list<Data>::const_iterator arrayIter = data.array.begin();
//		uint32_t index = 0;
		while(arrayIter != data.array.end()) {
//            luaData[index++] = getDataAsLua(_luaState, *arrayIter);
			luaData.append(getDataAsLua(_luaState, *arrayIter));
			arrayIter++;
		}
//		luaData["inspect"] = luaInspect;
		return luaData;
	}
	if (data.atom.size() > 0) {
		switch (data.type) {
		case Data::VERBATIM: {
			luaData = data.atom;
			break;
		}
		case Data::INTERPRETED: {
			if (isNumeric(data.atom.c_str(), 10)) {
				if (data.atom.find(".") != std::string::npos) {
					luaData = strTo<double>(data.atom);
				} else {
					luaData = strTo<long>(data.atom);
				}
			} else {
				int retVals = luaEval(_luaState, "return(" + data.atom + ");");
				if (retVals == 1) {
					luaData = luabridge::LuaRef::fromStack(_luaState, -1);
				}
				lua_pop(_luaState, retVals);
			}
		}
		}
		return luaData;
	}
	// hopefully this is nil
	return luabridge::LuaRef(_luaState);
}

LuaDataModel::LuaDataModel() {
	_luaState = NULL;
}

int LuaDataModel::luaInFunction(lua_State * l) {
	luabridge::LuaRef ref = luabridge::getGlobal(l, "__datamodel");
	LuaDataModel* dm = ref.cast<LuaDataModel*>();

	int stackSize = lua_gettop(l);
	for (int i = 0; i < stackSize; i++) {
		if (!lua_isstring(l, -1 - i))
			continue;
		std::string stateName = lua_tostring(l, -1 - i);
		if (dm->_callbacks->isInState(stateName))
			continue;
		lua_pushboolean(l, 0);
		return 1;
	}
	lua_pushboolean(l, 1);
	return 1;
}

std::shared_ptr<DataModelImpl> LuaDataModel::create(DataModelCallbacks* callbacks) {
	std::shared_ptr<LuaDataModel> dm(new LuaDataModel());
	dm->_callbacks = callbacks;
	dm->setup();
	return dm;
}

void LuaDataModel::setup() {
	_luaState = luaL_newstate();
	luaL_openlibs(_luaState);

    SWIG_init(_luaState);
    
#if 0
	try {
		const luabridge::LuaRef& requireFunc = luabridge::getGlobal(_luaState, "require");
		if (requireFunc.isFunction()) {
			const luabridge::LuaRef& resultLxp = requireFunc("lxp");
			const luabridge::LuaRef& resultLxpLOM = requireFunc("lxp.lom");

			// MSVC compiler bug with implicit cast operators, see comments in LuaRef class
			if ((bool)resultLxp && (bool)resultLxpLOM) {
				_luaHasXMLParser = true;
				luabridge::setGlobal(_luaState, resultLxp, "lxp");
				luabridge::setGlobal(_luaState, resultLxpLOM, "lxp.lom");
			}
		}
	} catch (luabridge::LuaException e) {
		LOG(_callbacks->getLogger(), USCXML_INFO) << e.what() << std::endl;
	}
#endif
    
	luabridge::getGlobalNamespace(_luaState).beginClass<LuaDataModel>("DataModel").endClass();
	luabridge::setGlobal(_luaState, this, "__datamodel");

	luabridge::getGlobalNamespace(_luaState).addCFunction("In", luaInFunction);

	luabridge::LuaRef ioProcTable = luabridge::newTable(_luaState);
	std::map<std::string, IOProcessor> ioProcs = _callbacks->getIOProcessors();
	std::map<std::string, IOProcessor>::const_iterator ioProcIter = ioProcs.begin();
	while(ioProcIter != ioProcs.end()) {
		Data ioProcData = ioProcIter->second.getDataModelVariables();
		ioProcTable[ioProcIter->first] = getDataAsLua(_luaState, ioProcData);
		ioProcIter++;
	}
	luabridge::setGlobal(_luaState, ioProcTable, "_ioprocessors");

	luabridge::LuaRef invTable = luabridge::newTable(_luaState);
	std::map<std::string, Invoker> invokers = _callbacks->getInvokers();
	std::map<std::string, Invoker>::const_iterator invIter = invokers.begin();
	while(invIter != invokers.end()) {
		Data invData = invIter->second.getDataModelVariables();
		invTable[invIter->first] = getDataAsLua(_luaState, invData);
		invIter++;
	}
	luabridge::setGlobal(_luaState, invTable, "_invokers");

	luabridge::setGlobal(_luaState, _callbacks->getName(), "_name");
	luabridge::setGlobal(_luaState, _callbacks->getSessionId(), "_sessionid");

}

LuaDataModel::~LuaDataModel() {
	if (_luaState != NULL)
		lua_close(_luaState);
}

void LuaDataModel::addExtension(DataModelExtension* ext) {
	ERROR_EXECUTION_THROW("Extensions unimplemented in lua datamodel");
}

void LuaDataModel::setEvent(const Event& event) {
	luabridge::LuaRef luaEvent(_luaState);
	luaEvent = luabridge::newTable(_luaState);

	luaEvent["name"] = event.name;
	if (event.raw.size() > 0)
		luaEvent["raw"] = event.raw;
	if (event.origin.size() > 0)
		luaEvent["origin"] = event.origin;
	if (event.origintype.size() > 0)
		luaEvent["origintype"] = event.origintype;
	if (event.invokeid.size() > 0)
		luaEvent["invokeid"] = event.invokeid;
	if (!event.hideSendId)
		luaEvent["sendid"] = event.sendid;
//	luaEvent["inspect"] = luaInspect;

	switch (event.eventType) {
	case Event::INTERNAL:
		luaEvent["type"] = "internal";
		break;
	case Event::EXTERNAL:
		luaEvent["type"] = "external";
		break;
	case Event::PLATFORM:
		luaEvent["type"] = "platform";
		break;

	default:
		break;
	}

	if (event.data.node) {
#ifndef NO_XERCESC
        SWIG_Lua_NewPointerObj(_luaState, event.data.node, SWIGTYPE_p_XERCES_CPP_NAMESPACE__DOMNode, SWIG_POINTER_DISOWN);
        luaEvent["data"] = luabridge::LuaRef::fromStack(_luaState, 1);
#else
        ERROR_EXECUTION_THROW("No DOM support in Lua datamodel");
#endif
	} else {
		// _event.data is KVP
		Data d = event.data;

		if (!event.params.empty()) {
			Event::params_t::const_iterator paramIter = event.params.begin();
			while(paramIter != event.params.end()) {
				d.compound[paramIter->first] = paramIter->second;
				paramIter++;
			}
		}
		if (!event.namelist.empty()) {
			Event::namelist_t::const_iterator nameListIter = event.namelist.begin();
			while(nameListIter != event.namelist.end()) {
				d.compound[nameListIter->first] = nameListIter->second;
				nameListIter++;
			}
		}

		if (!d.empty()) {
			luabridge::LuaRef luaData = getDataAsLua(_luaState, d);
			assert(luaEvent.isTable());
			// assert(luaData.isTable()); // not necessarily test179
			luaEvent["data"] = luaData;
		}
	}

	luabridge::setGlobal(_luaState, luaEvent, "_event");

}

Data LuaDataModel::evalAsData(const std::string& content) {
	Data data;

	std::string trimmedExpr = boost::trim_copy(content);

	int retVals = luaEval(_luaState, "return(" + trimmedExpr + ")");
	if (retVals == 1) {
		data = getLuaAsData(_luaState, luabridge::LuaRef::fromStack(_luaState, -1));
	}
	lua_pop(_luaState, retVals);
	return data;
}

void LuaDataModel::eval(const std::string& content) {
	std::string trimmedExpr = boost::trim_copy(content);

	int retVals = luaEval(_luaState, trimmedExpr);

	lua_pop(_luaState, retVals);
}

bool LuaDataModel::isLegalDataValue(const std::string& expr) {
    return isValidSyntax("local __tmp = " + expr);
}

bool LuaDataModel::isValidSyntax(const std::string& expr) {
	int preStack = lua_gettop(_luaState);
	int err = luaL_loadstring (_luaState, expr.c_str());

	// clean stack again
	lua_pop(_luaState, lua_gettop(_luaState) - preStack);


	if (err == LUA_ERRSYNTAX)
		return false;

	return true;
}

uint32_t LuaDataModel::getLength(const std::string& expr) {
	// we need the result of the expression on the lua stack -> has to "return"!
	std::string trimmedExpr = boost::trim_copy(expr);

	if (!boost::starts_with(trimmedExpr, "return")) {
		trimmedExpr = "return(#" + trimmedExpr + ")";
	}

	int retVals = luaEval(_luaState, trimmedExpr);

#if 1

	if (retVals == 1 && lua_isnumber(_luaState, -1)) {
		int result = lua_tointeger(_luaState, -1);
		lua_pop(_luaState, 1);
		return result;
	}

	lua_pop(_luaState, retVals);
	ERROR_EXECUTION_THROW("'" + expr + "' does not evaluate to an array.");
	return 0;
#else

	if (retVals == 1) {
		luabridge::LuaRef luaData = luabridge::LuaRef::fromStack(_luaState, -1);
		if (luaData.isNumber()) {
			lua_pop(_luaState, retVals);
			return luaData.cast<int>();
		}
	}
	lua_pop(_luaState, retVals);

	ERROR_EXECUTION_THROW("'" + expr + "' does not evaluate to an array.");
	return 0;

#endif
}

void LuaDataModel::setForeach(const std::string& item,
                              const std::string& array,
                              const std::string& index,
                              uint32_t iteration) {
	iteration++; // test153: arrays start at 1

	const luabridge::LuaRef& arrRef = luabridge::getGlobal(_luaState, array.c_str());
	if (arrRef.isTable()) {

		// triggers syntax error for invalid items, test 152
		int retVals = luaEval(_luaState, item + " = " + array + "[" + toStr(iteration) + "]");
		lua_pop(_luaState, retVals);

		if (index.length() > 0) {
			int retVals = luaEval(_luaState, index + " = " + toStr(iteration));
			lua_pop(_luaState, retVals);
		}
	}
}

bool LuaDataModel::isDeclared(const std::string& expr) {
	// see: http://lua-users.org/wiki/DetectingUndefinedVariables
	return true;
}


void LuaDataModel::assign(const std::string& location, const Data& data, const std::map<std::string, std::string>& attr) {
	if (location.length() == 0) {
		ERROR_EXECUTION_THROW("Assign element has neither id nor location");
	}

	// flags on attribute are ignored?
	if (location.compare("_sessionid") == 0) // test 322
		ERROR_EXECUTION_THROW("Cannot assign to _sessionId");
	if (location.compare("_name") == 0)
		ERROR_EXECUTION_THROW("Cannot assign to _name");
	if (location.compare("_ioprocessors") == 0)  // test 326
		ERROR_EXECUTION_THROW("Cannot assign to _ioprocessors");
	if (location.compare("_invokers") == 0)
		ERROR_EXECUTION_THROW("Cannot assign to _invokers");
	if (location.compare("_event") == 0)
		ERROR_EXECUTION_THROW("Cannot assign to _event");

	if (data.node) {
#ifndef NO_XERCESC

        SWIG_Lua_NewPointerObj(_luaState, data.node, SWIGTYPE_p_XERCES_CPP_NAMESPACE__DOMNode, SWIG_POINTER_DISOWN);
        lua_setglobal(_luaState, "__tmpAssign");
        eval(location + "= __tmpAssign");
#else
		ERROR_EXECUTION_THROW("Cannot assign xml nodes in lua datamodel");
#endif
	} else {


		luabridge::LuaRef lua = getDataAsLua(_luaState, data);

		luabridge::setGlobal(_luaState, lua, "__tmpAssign");
		eval(location + "= __tmpAssign");


//        LOG(_callbacks->getLogger(), USCXML_INFO) << Data::toJSON(evalAsData(location)) << std::endl;
	}
}

void LuaDataModel::init(const std::string& location, const Data& data, const std::map<std::string, std::string>& attr) {
	luabridge::setGlobal(_luaState, luabridge::Nil(), location.c_str());
	assign(location, data);
}

bool LuaDataModel::evalAsBool(const std::string& expr) {
	// we need the result of the expression on the lua stack -> has to "return"!
	std::string trimmedExpr = boost::trim_copy(expr);

	int retVals = luaEval(_luaState, "return(" + trimmedExpr + ")");

	if (retVals == 1) {
		bool result = lua_toboolean(_luaState, -1);
		lua_pop(_luaState, 1);
		return result;
	}
	lua_pop(_luaState, retVals);

	return false;
}

Data LuaDataModel::getAsData(const std::string& content) {
	Data data;
	std::string trimmedExpr = boost::trim_copy(content);

	int retVals = luaEval(_luaState, "__tmp = " + content + "; return __tmp");
	if (retVals == 1) {
		data = getLuaAsData(_luaState, luabridge::LuaRef::fromStack(_luaState, -1));
	}
	lua_pop(_luaState, retVals);

	// escape as a string, this is sometimes the case with <content>
	if (data.atom == "nil" && data.type == Data::INTERPRETED) {
		int retVals = luaEval(_luaState, "__tmp = '" + content + "'; return __tmp");
		if (retVals == 1) {
			data = getLuaAsData(_luaState, luabridge::LuaRef::fromStack(_luaState, -1));
		}
		lua_pop(_luaState, retVals);
	}

	return data;
}

}