//=============================================================================
// METHOD: SPELLclientIPC::
//=============================================================================
SPELLipcMessage SPELLclientIPC::processRequest( const SPELLipcMessage& msg )
{
int clientKey = msg.getKey();
DEBUG("[CLTRCV] Received request from client: " + msg.getId());
SPELLipcMessage resp = VOID_MESSAGE;
SPELLclientInterestList* list = getClientInterestList(clientKey);
// If the message is a login message, redirect it to the client manager
if (msg.getId() == ContextMessages::REQ_GUI_LOGIN)
{
SPELLclientManager::instance().clientLogin(clientKey, msg.get( MessageField::FIELD_HOST ));
resp = SPELLipcHelper::createResponse(ContextMessages::RSP_GUI_LOGIN, msg);
}
// If the message is a logout message, redirect it to the client manager
else if (msg.getId() == ContextMessages::REQ_GUI_LOGOUT )
{
// No need to close IPC here. When the GUI receives the response,
// it will close the channel by sending EOC. There, IPC layer will
// automatically close the corresponding channel.
SPELLclientManager::instance().clientLogout(clientKey);
resp = SPELLipcHelper::createResponse(ContextMessages::RSP_GUI_LOGOUT, msg);
}
else if (list != NULL)
{
//DEBUG("[CLTRCV] Distribute client request: " + msg.getId());
resp = list->distributeRequest(msg);
//DEBUG("[CLTRCV] Got response for client request: " + msg.getId());
// Executor request additional processing (request attended by executor that need to be processed in context also)
// But only if the response is not an error
if (resp.getType() != MSG_TYPE_ERROR)
{
if (msg.getId() == ExecutorMessages::REQ_SET_CONFIG)
{
SPELLipcMessage cfgChange( msg );
cfgChange.setId( ContextMessages::MSG_EXEC_CONFIG );
cfgChange.setType( MSG_TYPE_ONEWAY );
SPELLclientManager::instance().notifyMonitoringClients(&cfgChange);
}
}
if (resp.isVoid())
{
LOG_ERROR("Unable to get response for client request " + msg.getId());
}
}
else
{
LOG_ERROR("No listeners for client " + ISTR(clientKey) + " to distribute request: " + msg.getId());
}
return resp;
}
//=============================================================================
// METHOD: SPELLlistenerContext::processRequest
//=============================================================================
SPELLipcMessage SPELLlistenerContext::processRequest( const SPELLipcMessage& msg )
{
DEBUG("Got request: " + msg.getId());
// No request from context yet
return VOID_MESSAGE;
}
//=============================================================================
// METHOD: SPELLlistenerContext::processMessage
//=============================================================================
void SPELLlistenerContext::processMessage( const SPELLipcMessage& msg )
{
DEBUG("Got message: " + msg.getId());
if (msg.getId() == ListenerMessages::MSG_CONTEXT_OPEN)
{
this->onNewContext(msg);
}
else if (msg.getId() == ListenerMessages::MSG_CONTEXT_CLOSED)
{
this->onClosedContext(msg);
}
else
{
LOG_ERROR("Unprocessed message: " + msg.getId())
}
}
//=============================================================================
// METHOD: SPELLexecutorIPC::
//=============================================================================
void SPELLexecutorIPC::processMessage( const SPELLipcMessage& msg )
{
TICK_IN;
DEBUG("[EXCIPC] Received message from executor: " + msg.dataStr());
// Certain messages are for monitoring clients only
if ((msg.getId() != MessageId::MSG_ID_PROMPT_START)&&(msg.getId() != MessageId::MSG_ID_PROMPT_END))
{
DEBUG("[EXCIPC] Forward message to controller");
m_controller.processMessageFromExecutor(msg);
}
if (msg.getId() != ExecutorMessages::MSG_NOTIF_EXEC_CLOSE)
{
DEBUG("[EXCIPC] Forward message to monitoring clients");
notifyMessage(msg);
}
DEBUG("[EXCIPC] Message processed");
TICK_OUT;
}
//=============================================================================
// METHOD: SPELLclient::
//=============================================================================
void SPELLclient::processMessageFromClient( const SPELLipcMessage& msg )
{
std::string procId = msg.get( MessageField::FIELD_PROC_ID );
SPELLexecutor* exec = SPELLexecutorManager::instance().getExecutor(procId);
if (exec)
{
if (msg.getId() == ExecutorMessages::ACKNOWLEDGE)
{
if (exec->getControllingClient() != this)
{
return;
}
}
exec->sendMessageToExecutor(msg);
}
else
{
LOG_ERROR("Cannot send message, no suitable executor found");
}
}
//=============================================================================
// METHOD: SPELLexecutorIPC::processConnectionError
//=============================================================================
bool SPELLexecutorIPC::shouldForwardToMonitoring( const SPELLipcMessage& msg )
{
std::string requestId = msg.getId();
if (msg.getType() == MSG_TYPE_PROMPT)
{
return false;
}
if ( requestId == ContextMessages::REQ_OPEN_EXEC )
{
return false;
}
else if ( requestId == ContextMessages::REQ_INSTANCE_ID )
{
return false;
}
else if ( requestId == ContextMessages::REQ_EXEC_INFO )
{
return false;
}
else if ( requestId == ContextMessages::REQ_DEL_SHARED_DATA )
{
return false;
}
else if ( requestId == ContextMessages::REQ_SET_SHARED_DATA )
{
return false;
}
else if ( requestId == ContextMessages::REQ_GET_SHARED_DATA )
{
return false;
}
else if ( requestId == ContextMessages::REQ_GET_SHARED_DATA_KEYS )
{
return false;
}
return true;
}
//=============================================================================
// METHOD: SPELLlistenerContext::displace
//=============================================================================
SPELLipcMessage SPELLlistenerContext::displace( const SPELLipcMessage& msg )
{
SPELLipcMessage res = VOID_MESSAGE;
std::string name;
DEBUG("Got IPC object: " + msg.getId());
if (msg.getId() == ContextMessages::REQ_OPEN_CTX)
res = this->startContext(msg);
else if (msg.getId() == ContextMessages::REQ_CLOSE_CTX)
res = this->stopContext(msg);
else if (msg.getId() == ContextMessages::REQ_CTX_INFO)
res = this->contextInfo(msg);
else if (msg.getId() == ContextMessages::REQ_ATTACH_CTX)
res = this->attachContext(msg);
else if (msg.getId() == ContextMessages::REQ_DESTROY_CTX)
res = this->destroyContext(msg);
else
LOG_ERROR("Unprocessed message: " + msg.getId())
DEBUG("Response IPC object: " + res.dataStr());
return res;
}
//=============================================================================
// METHOD: SPELLserverCif::prompt
//=============================================================================
std::string SPELLserverCif::prompt( const std::string& message, PromptOptions options, unsigned int ptype, unsigned int scope )
{
DEBUG("[CIF] Prompt message");
std::string timeStr = getTimestampUsec();
SPELLipcMessage promptMessage(MessageId::MSG_ID_PROMPT);
completeMessage( &promptMessage );
promptMessage.setType(MSG_TYPE_PROMPT);
promptMessage.set(MessageField::FIELD_PROC_ID, getProcId() );
promptMessage.set(MessageField::FIELD_TEXT, message);
promptMessage.set(MessageField::FIELD_DATA_TYPE, ISTR(ptype));
promptMessage.set(MessageField::FIELD_TIME, timeStr);
promptMessage.set(MessageField::FIELD_SCOPE, ISTR(scope));
// Used for the prompt display message
PromptOptions optionsToShow;
DEBUG("[CIF] Prompt typecode " + ISTR(ptype));
if (ptype == LanguageConstants::PROMPT_NUM ||
ptype == LanguageConstants::PROMPT_ALPHA ||
ptype == LanguageConstants::PROMPT_DATE )
{
DEBUG("[CIF] Prompt is simple");
promptMessage.set(MessageField::FIELD_EXPECTED, "");
}
else if ( ptype & LanguageConstants::PROMPT_LIST )
{
DEBUG("[CIF] Prompt is list");
PromptOptions::iterator it;
int keyCount = 1;
std::string optionStr = "";
std::string expectedStr = "";
// Iterate over the option list and build the option and expected values strings
for( it = options.begin(); it != options.end(); it++)
{
std::string key;
std::string value;
std::string opt = (*it);
DEBUG("[CIF] Option: " + opt);
if (optionStr.size()>0) optionStr += IPCinternals::OPT_SEPARATOR;
if (expectedStr.size()>0) expectedStr += IPCinternals::OPT_SEPARATOR;
if ( opt.find(IPCinternals::KEY_SEPARATOR) == std::string::npos )
{
// Put an internal key in this case
key = ISTR(keyCount);
value = opt;
// Trim the value
trim(value);
}
else
{
int idx = opt.find(IPCinternals::KEY_SEPARATOR);
key = opt.substr(0, idx);
// Trim the key
trim(key);
value = opt.substr(idx+1, opt.size()-idx);
// Trim the value
trim(value);
}
DEBUG("[CIF] Option key: '" + key + "'");
DEBUG("[CIF] Option value: '" + value + "'");
optionStr += key + IPCinternals::KEY_SEPARATOR + value;
optionsToShow.push_back(key + ": " + value);
if (ptype & LanguageConstants::PROMPT_ALPHA)
{
expectedStr += value;
DEBUG("[CIF] Expected: " + value);
}
else
{
expectedStr += key;
DEBUG("[CIF] Expected: " + key);
}
keyCount++;
}
promptMessage.set(MessageField::FIELD_EXPECTED, expectedStr);
promptMessage.set(MessageField::FIELD_OPTIONS, optionStr);
}
else if (ptype == LanguageConstants::PROMPT_OK)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "O");
promptMessage.set(MessageField::FIELD_OPTIONS, "O" + IPCinternals::KEY_SEPARATOR + " Ok");
optionsToShow.push_back("O: Ok");
}
else if (ptype == LanguageConstants::PROMPT_CANCEL)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "C");
promptMessage.set(MessageField::FIELD_OPTIONS, "C" + IPCinternals::KEY_SEPARATOR + " Cancel");
optionsToShow.push_back("C: Cancel");
}
else if (ptype == LanguageConstants::PROMPT_YES)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "Y");
promptMessage.set(MessageField::FIELD_OPTIONS, "Y" + IPCinternals::KEY_SEPARATOR + " Yes");
optionsToShow.push_back("Y: Yes");
}
else if (ptype == LanguageConstants::PROMPT_NO)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "N");
promptMessage.set(MessageField::FIELD_OPTIONS, "N" + IPCinternals::KEY_SEPARATOR + " No");
optionsToShow.push_back("N: No");
}
else if (ptype == LanguageConstants::PROMPT_YES_NO)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "Y|N");
promptMessage.set(MessageField::FIELD_OPTIONS, "Y" + IPCinternals::KEY_SEPARATOR + " Yes|N" + IPCinternals::KEY_SEPARATOR + " No");
optionsToShow.push_back("Y: Yes");
optionsToShow.push_back("N: No");
}
else if (ptype == LanguageConstants::PROMPT_OK_CANCEL)
{
promptMessage.set(MessageField::FIELD_EXPECTED, "O|C");
promptMessage.set(MessageField::FIELD_OPTIONS, "O" + IPCinternals::KEY_SEPARATOR + " Ok|C" + IPCinternals::KEY_SEPARATOR + " Cancel");
optionsToShow.push_back("O: Ok");
optionsToShow.push_back("C: Cancel");
}
DEBUG("[CIF] Option string: " + promptMessage.get(MessageField::FIELD_OPTIONS));
DEBUG("[CIF] Expected string: " + promptMessage.get(MessageField::FIELD_EXPECTED));
// Write the prompt display
std::string msgToShow = message;
if (optionsToShow.size()>0)
{
msgToShow += "\nAvailable options:\n";
for(PromptOptions::iterator pit = optionsToShow.begin(); pit != optionsToShow.end(); pit++)
{
msgToShow += " - " + (*pit) + "\n";
}
}
// Send the display message via the buffer to ensure synchronization
m_buffer->prompt(msgToShow, LanguageConstants::SCOPE_PROMPT);
// Ensure buffer is flushed
m_buffer->flush();
// Write the prompt in the asrun
m_asRun->writePrompt( getStack(), message, scope );
DEBUG("[CIF] Messsage prepared");
// Send request to client
SPELLipcMessage* response = sendGUIRequest(&promptMessage, SPELL_CIF_PROMPT_TIMEOUT_SEC);
DEBUG("[CIF] Prompt response received");
std::string toProcess = "";
if (response->getId() == MessageId::MSG_ID_CANCEL)
{
LOG_WARN("Prompt cancelled");
DEBUG("[CIF] Prompt cancelled");
toProcess = PROMPT_CANCELLED;
// Abort execution in this case
SPELLexecutor::instance().abort("Prompt cancelled",true);
}
else if (response->getId() == MessageId::MSG_ID_TIMEOUT)
{
LOG_ERROR("Prompt timed out");
DEBUG("[CIF] Prompt timed out");
toProcess = PROMPT_TIMEOUT;
// Abort execution in this case
SPELLexecutor::instance().abort("Prompt timed out", true);
}
else if (response->getType() == MSG_TYPE_ERROR)
{
std::string errorMsg = response->get( MessageField::FIELD_ERROR );
DEBUG("[CIF] Prompt error: " + errorMsg );
LOG_ERROR("Prompt error: " + errorMsg);
toProcess = PROMPT_ERROR;
// \todo Should fix this and use an error code
if (errorMsg == "No controlling client")
{
warning("No controlling client to issue prompt!", LanguageConstants::SCOPE_SYS );
SPELLexecutor::instance().pause();
}
else
{
error( "Prompt error: " + errorMsg, LanguageConstants::SCOPE_SYS );
// Abort execution in this case
SPELLexecutor::instance().abort("Prompt error",true);
}
}
else
{
toProcess = response->get(MessageField::FIELD_RVALUE);
DEBUG("[CIF] Prompt response: " + toProcess);
}
// \todo When there is no controlling client we should keep the child procedure in prompt waiting state
// Send the display message via the buffer to ensure synchronization
m_buffer->write("Answer: '" + toProcess + "'", LanguageConstants::SCOPE_PROMPT);
m_buffer->flush();
m_asRun->writeAnswer( getStack(), toProcess, scope );
return toProcess;
}
//=============================================================================
// METHOD: SPELLclient::
//=============================================================================
SPELLipcMessage SPELLclient::processRequestFromClient( const SPELLipcMessage& msg )
{
//DEBUG(" Client request start");
// Create the login message
std::string requestId = msg.getId();
SPELLipcMessage resp = VOID_MESSAGE;
try
{
if ( requestId == ContextMessages::REQ_INSTANCE_ID )
{
resp = SPELLcontext::instance().getInstanceId( msg );
}
else if ( requestId == ContextMessages::REQ_OPEN_EXEC )
{
resp = SPELLcontext::instance().openExecutor( msg, this );
}
else if ( requestId == ContextMessages::REQ_CLOSE_EXEC )
{
resp = SPELLcontext::instance().closeExecutor( msg );
}
else if ( requestId == ContextMessages::REQ_KILL_EXEC )
{
resp = SPELLcontext::instance().killExecutor( msg );
}
else if ( requestId == ContextMessages::REQ_ATTACH_EXEC )
{
resp = SPELLcontext::instance().attachExecutor( msg, this );
}
else if ( requestId == ContextMessages::REQ_DETACH_EXEC )
{
resp = SPELLcontext::instance().detachExecutor( msg, this );
}
else if (msg.getId() == ContextMessages::REQ_RECOVER_EXEC)
{
resp = SPELLcontext::instance().recoverExecutor( msg, this );
}
else if (msg.getId() == ContextMessages::REQ_PROC_LIST)
{
resp = SPELLcontext::instance().getProcedureList( msg );
}
else if (msg.getId() == ContextMessages::REQ_EXEC_LIST)
{
resp = SPELLcontext::instance().getExecutorList( msg );
}
else if (msg.getId() == ContextMessages::REQ_PROC_PROP)
{
resp = SPELLcontext::instance().getProcedureProperties( msg );
}
else if (msg.getId() == ContextMessages::REQ_PROC_CODE)
{
resp = SPELLcontext::instance().getProcedureCode( msg );
}
else if (msg.getId() == ContextMessages::REQ_EXEC_INFO)
{
resp = SPELLcontext::instance().getExecutorInfo( msg );
}
else if (msg.getId() == ContextMessages::REQ_CLIENT_INFO)
{
resp = SPELLcontext::instance().getClientInfo( msg );
}
else if (msg.getId() == ContextMessages::REQ_SERVER_FILE_PATH)
{
resp = SPELLcontext::instance().getServerFilePath( msg );
}
else if (msg.getId() == ContextMessages::REQ_RECOVERY_LIST)
{
resp = SPELLcontext::instance().getProcedureRecoveryList( msg );
}
else if (msg.getId() == ContextMessages::REQ_ASRUN_LIST)
{
resp = SPELLcontext::instance().getProcedureAsRunList( msg );
}
else if (msg.getId() == ContextMessages::REQ_DELETE_RECOVERY )
{
resp = SPELLcontext::instance().deleteRecoveryFiles(msg);
}
else if (msg.getId() == ContextMessages::REQ_REMOVE_CONTROL )
{
resp = SPELLcontext::instance().removeControl(msg);
}
else if (msg.getId() == ContextMessages::REQ_SET_BACKGROUND )
{
resp = SPELLcontext::instance().setExecutorInBackground(msg);
}
else if (msg.getId() == ContextMessages::REQ_LIST_FILES )
{
resp = SPELLcontext::instance().listFiles(msg);
}
else if (msg.getId() == ContextMessages::REQ_LIST_DATADIRS )
{
resp = SPELLcontext::instance().listDataDirectories(msg);
}
else if (msg.getId() == ContextMessages::REQ_INPUT_FILE )
{
resp = SPELLcontext::instance().getInputFile(msg);
}
else if (msg.getId() == ContextMessages::REQ_CURRENT_TIME )
{
resp = SPELLcontext::instance().getCurrentTime(msg);
}
else if ( requestId == ContextMessages::REQ_DEL_SHARED_DATA )
{
resp = SPELLcontext::instance().clearSharedData(msg);
}
else if ( requestId == ContextMessages::REQ_SET_SHARED_DATA )
{
resp = SPELLcontext::instance().setSharedData(msg);
}
else if ( requestId == ContextMessages::REQ_GET_SHARED_DATA )
{
resp = SPELLcontext::instance().getSharedData(msg);
}
else if ( requestId == ContextMessages::REQ_GET_SHARED_DATA_KEYS )
{
resp = SPELLcontext::instance().getSharedDataKeys(msg);
}
else if ( requestId == ContextMessages::REQ_GET_SHARED_DATA_SCOPES )
{
resp = SPELLcontext::instance().getSharedDataScopes(msg);
}
else if ( requestId == ContextMessages::REQ_DEL_SHARED_DATA_SCOPE )
{
resp = SPELLcontext::instance().removeSharedDataScope(msg);
}
else if ( requestId == ContextMessages::REQ_ADD_SHARED_DATA_SCOPE )
{
resp = SPELLcontext::instance().addSharedDataScope(msg);
}
else if ( requestId == ContextMessages::REQ_GET_CTX_EXEC_DFLT )
{
resp = SPELLcontext::instance().getExecutorDefaults(msg);
}
else if ( requestId == ContextMessages::REQ_SET_CTX_EXEC_DFLT )
{
resp = SPELLcontext::instance().setExecutorDefaults(msg);
}
else
{
// Forward the request to the executor
std::string procId = msg.get( MessageField::FIELD_PROC_ID );
try
{
DEBUG( NAME + "Forward request to executor " + procId +": " + msg.getId());
SPELLexecutor* exec = SPELLexecutorManager::instance().getExecutor(procId);
resp = exec->sendRequestToExecutor(msg);
if (resp.isVoid())
{
LOG_ERROR("Unable to obtain response for client request " + msg.getId() + " from executor ");
}
}
catch( SPELLcoreException& ex )
{
LOG_ERROR( NAME + "Unable to send request to executor '" + procId + "', unable to find");
std::string id = msg.getId();
SPELLutils::replace(id, "REQ", "RSP");
resp = SPELLipcHelper::createErrorResponse(id,msg);
resp.set(MessageField::FIELD_ERROR, "Unable to send request to executor " + procId);
resp.set(MessageField::FIELD_REASON, "Cannot find the executor");
resp.set(MessageField::FIELD_FATAL, PythonConstants::True );
}
}
}
catch(SPELLexecutorManager::OperationError& err)
{
LOG_ERROR( NAME + "Error in client request processing " + ISTR(err.errorCode));
std::string id = msg.getId();
SPELLutils::replace(id, "REQ", "RSP");
resp = SPELLipcHelper::createErrorResponse(id,msg);
resp.set(MessageField::FIELD_ERROR, "Error in client processing");
resp.set(MessageField::FIELD_REASON, err.message);
resp.set(MessageField::FIELD_FATAL, PythonConstants::True);
}
catch(...)
{
LOG_ERROR( NAME + "Unknown error in client request processing");
std::string id = msg.getId();
SPELLutils::replace(id, "REQ", "RSP");
resp = SPELLipcHelper::createErrorResponse(id,msg);
resp.set(MessageField::FIELD_ERROR, "Error in client processing");
resp.set(MessageField::FIELD_REASON, "Unknown reason");
resp.set(MessageField::FIELD_FATAL, PythonConstants::True);
}
//DEBUG(" Client request end");
return resp;
}