Method HandleCommandLine

Core/KernelSML/src/sml_KernelSMLHandlers.cpp:895–1035

Executes a generic command line for a specific agent

// Executes a generic command line for a specific agent
bool KernelSML::HandleCommandLine(AgentSML* pAgentSML, char const* pCommandName, Connection* pConnection, AnalyzeXML* pIncoming, soarxml::ElementXML* pResponse)
{
#ifdef _DEBUG
    bool kDebugCommandLine = false ;
#else
    bool kDebugCommandLine = false ;
#endif
    
    // Get the parameters
    char const* pLine = pIncoming->GetArgString(sml_Names::kParamLine) ;
    bool echoResults  = pIncoming->GetArgBool(sml_Names::kParamEcho, false) ;
    bool noFiltering  = pIncoming->GetArgBool(sml_Names::kParamNoFiltering, false) ;
    
    // If the user chooses to enable this feature, certain commands are always echoed back.
    // This is primarily to support two users connected to and debugging the same kernel at once.
    if (GetEchoCommands() && m_CommandLineInterface.ShouldEchoCommand(pLine))
    {
        echoResults = true ;
    }
    
    bool rawOutput = false;
    
    // The caller can ask for simple string output (raw output) or more complex, structured XML output
    // which can then be parsed.
    soarxml::ElementXML const* pCommand = pIncoming->GetCommandTag() ;
    const char* pCommandOutput = pCommand->GetAttribute(sml_Names::kCommandOutput) ;
    
    if (pCommandOutput)
    {
        rawOutput = (strcmp(pCommandOutput, sml_Names::kRawOutput) == 0) ;
    }
    
    if (!pLine)
    {
        return InvalidArg(pConnection, pResponse, pCommandName, "Command line missing") ;
    }
    
    if (kDebugCommandLine)
    {
        sml::PrintDebugFormat("Executing %s", pLine) ;
    }
    
    // If we're echoing the results, also echo the command we're executing
    if (echoResults && pAgentSML)
    {
        pAgentSML->FireEchoEvent(pConnection, pLine) ;
    }
    
    if (kDebugCommandLine)
    {
        sml::PrintDebugFormat("Echoed line\n") ;
    }
    
    // Send this command line through anyone registered filters.
    // If there are no filters (or this command requested not to be filtered), this copies the original line into the filtered line unchanged.
    char const* pFilteredLine   = pLine ;
    bool filteredError = false ;
    soarxml::ElementXML* pFilteredXML = NULL ;