X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FNetwork%2Fprops.cxx;h=3504f99c8c75115730f0a0584e6e49310d05a8f4;hb=0aabc112b4f586f94365ccf1e906d6e4fb78dc10;hp=29730db427b48f458f444a511a5b34fb68d6925d;hpb=63bbe7de75780857d2d8896dd6af72e380fd97ab;p=flightgear.git diff --git a/src/Network/props.cxx b/src/Network/props.cxx index 29730db42..3504f99c8 100644 --- a/src/Network/props.cxx +++ b/src/Network/props.cxx @@ -1,6 +1,8 @@ -// props.hxx -- FGFS property manager interaction class +// \file props.cxx +// Property server class. // // Written by Curtis Olson, started September 2000. +// Modified by Bernie Bright, May 2002. // // Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org // @@ -21,253 +23,491 @@ // $Id$ +#ifdef HAVE_CONFIG_H +# include +#endif + #include #include -#include -#include -#include +#include +#include +#include +#include -#include // atoi() atof() +#include -#include +#include
+#include
-#include "props.hxx" +#include -FG_USING_STD(cout); -FG_USING_STD(istrstream); +#include "props.hxx" -FGProps::FGProps() { +SG_USING_STD(stringstream); +SG_USING_STD(ends); + +/** + * Props connection class. + * This class represents a connection to props client. + */ +class PropsChannel : public netChat +{ + netBuffer buffer; + + /** + * Current property node name. + */ + string path; + + enum Mode { + PROMPT, + DATA + }; + Mode mode; + +public: + /** + * Constructor. + */ + PropsChannel(); + + /** + * Append incoming data to our request buffer. + * + * @param s Character string to append to buffer + * @param n Number of characters to append. + */ + void collectIncomingData( const char* s, int n ); + + /** + * Process a complete request from the props client. + */ + void foundTerminator(); + +private: + /** + * Return a "Node no found" error message to the client. + */ + void node_not_found_error( const string& node_name ); +}; + +/** + * + */ +PropsChannel::PropsChannel() + : buffer(512), + path("/"), + mode(PROMPT) +{ + setTerminator( "\r\n" ); } -FGProps::~FGProps() { +/** + * + */ +void +PropsChannel::collectIncomingData( const char* s, int n ) +{ + buffer.append( s, n ); } - -// open hailing frequencies -bool FGProps::open() { - path = "/"; - - if ( is_enabled() ) { - FG_LOG( FG_IO, FG_ALERT, "This shouldn't happen, but the channel " - << "is already in use, ignoring" ); - return false; - } - - SGIOChannel *io = get_io_channel(); - - if ( ! io->open( get_direction() ) ) { - FG_LOG( FG_IO, FG_ALERT, "Error opening channel communication layer." ); - return false; - } - - set_enabled( true ); - - return true; +/** + * + */ +void +PropsChannel::node_not_found_error( const string& node_name ) +{ + string error = "-ERR Node \""; + error += node_name; + error += "\" not found."; + push( error.c_str() ); + push( getTerminator() ); } - // return a human readable form of the value "type" -static string getValueTypeString( const SGValue *v ) { +static string +getValueTypeString( const SGPropertyNode *node ) +{ string result; - if ( v == NULL ) { + if ( node == NULL ) + { return "unknown"; } - SGValue::Type type = v->getType(); - if ( type == SGValue::UNKNOWN ) { - result = "unknown"; - } else if ( type == SGValue::BOOL ) { + SGPropertyNode::Type type = node->getType(); + if ( type == SGPropertyNode::UNSPECIFIED ) { + result = "unspecified"; + } else if ( type == SGPropertyNode::NONE ) { + result = "none"; + } else if ( type == SGPropertyNode::BOOL ) { result = "bool"; - } else if ( type == SGValue::INT ) { + } else if ( type == SGPropertyNode::INT ) { result = "int"; - } else if ( type == SGValue::FLOAT ) { + } else if ( type == SGPropertyNode::LONG ) { + result = "long"; + } else if ( type == SGPropertyNode::FLOAT ) { result = "float"; - } else if ( type == SGValue::DOUBLE ) { + } else if ( type == SGPropertyNode::DOUBLE ) { result = "double"; - } else if ( type == SGValue::STRING ) { + } else if ( type == SGPropertyNode::STRING ) { result = "string"; } return result; } +/** + * We have a command. + * + */ +void +PropsChannel::foundTerminator() +{ + const char* cmd = buffer.getData(); + SG_LOG( SG_IO, SG_INFO, "processing command = \"" << cmd << "\"" ); + + vector tokens = simgear::strutils::split( cmd ); + + SGPropertyNode* node = globals->get_props()->getNode( path.c_str() ); + + if (!tokens.empty()) { + string command = tokens[0]; + + if (command == "ls") { + SGPropertyNode* dir = node; + if (tokens.size() == 2) { + if (tokens[1][0] == '/') { + dir = globals->get_props()->getNode( tokens[1].c_str() ); + } else { + string s = path; + s += "/"; + s += tokens[1]; + dir = globals->get_props()->getNode( s.c_str() ); + } -bool FGProps::process_command( const char *cmd ) { - SGIOChannel *io = get_io_channel(); - - cout << "processing command = " << cmd; - string_list tokens; - tokens.clear(); - - istrstream in(cmd); - - while ( !in.eof() ) { - string token; - in >> token; - tokens.push_back( token ); - } - - string command = tokens[0]; + if (dir == 0) { + node_not_found_error( tokens[1] ); + goto prompt; + } + } - SGPropertyNode node( path, ¤t_properties ); - if ( node.getPath() == "" ) { - node.setPath( "/" ); - } + for (int i = 0; i < dir->nChildren(); i++) { + SGPropertyNode * child = dir->getChild(i); + string line = child->getDisplayName(true); + + if ( child->nChildren() > 0 ) { + line += "/"; + } else { + if (mode == PROMPT) { + string value = child->getStringValue(); + line += " =\t'" + value + "'\t("; + line += getValueTypeString( child ); + line += ")"; + } + } - if ( command == "ls" ) { - for (int i = 0; i < (int)node.size(); i++) { - SGPropertyNode child = node.getChild(i); - string name = child.getName(); - string line = name; - if ( child.size() > 0 ) { - line += "/\n"; + line += getTerminator(); + push( line.c_str() ); + } + } else if ( command == "dump" ) { + stringstream buf; + if ( tokens.size() <= 1 ) { + writeProperties( buf, node ); + buf << ends; // null terminate the string + push( buf.str().c_str() ); + push( getTerminator() ); } else { - string value = node.getStringValue ( name, "" ); - line += " =\t'" + value + "'\t("; - line += getValueTypeString( node.getValue( name ) ); - line += ")\n"; + SGPropertyNode *child = node->getNode( tokens[1].c_str() ); + if ( child ) { + writeProperties ( buf, child ); + buf << ends; // null terminate the string + push( buf.str().c_str() ); + push( getTerminator() ); + } else { + node_not_found_error( tokens[1] ); + } } - io->writestring( line.c_str() ); - } - } else if ( command == "cd" ) { - // string tmp = "current path = " + node.getPath() + "\n"; - // io->writestring( tmp.c_str() ); - - if ( tokens.size() <= 1 ) { - // do nothing - } else if ( tokens[1] == "." ) { - // do nothing - } else if ( tokens[1] == ".." ) { - // go back one level - string current = node.getPath(); - int pos = current.rfind("/"); - // cout << "path = " << current << endl; - // cout << "new path = " << current.substr(0, pos) << endl;d - string tmp = current.substr(0, pos); - node.setPath( tmp ); - path = tmp; - } else { - // decend to specified child - string tmp = node.getPath(); - tmp += "/" + tokens[1]; - node.setPath( tmp ); - path = tmp; - } - } else if ( command == "show" ) { - if ( tokens.size() <= 1 ) { - // do nothing - } else { - string ttt = "debug = '" + tokens[1] + "'\n"; - io->writestring( ttt.c_str() ); - - string value = node.getStringValue ( tokens[1], "" ); - string tmp = tokens[1] + " = '" + value + "' ("; - tmp += getValueTypeString( node.getValue( tokens[1] ) ); - tmp += ")\n"; - - io->writestring( tmp.c_str() ); } - } else if ( command == "set" ) { - if ( tokens.size() <= 2 ) { - // do nothing - } else { - SGValue *v = node.getValue( tokens[1] ); - if ( v != NULL ) { - SGValue::Type type = v->getType(); - if ( type == SGValue::UNKNOWN ) { - v->setUnknownValue( tokens[2] ); - } else if ( type == SGValue::BOOL ) { - if ( tokens[2] == "true" ) { - v->setBoolValue( true ); - } else if ( tokens[2] == "false" ) { - v->setBoolValue( false ); + else if ( command == "cd" ) { + if (tokens.size() == 2) { + try { + SGPropertyNode* child = node->getNode( tokens[1].c_str() ); + if ( child ) { + node = child; + path = node->getPath(); } else { - v->setBoolValue( atoi( tokens[2].c_str() ) ); + node_not_found_error( tokens[1] ); } - } else if ( type == SGValue::INT ) { - v->setIntValue( atoi( tokens[2].c_str() ) ); - } else if ( type == SGValue::FLOAT ) { - v->setFloatValue( atof( tokens[2].c_str() ) ); - } else if ( type == SGValue::DOUBLE ) { - v->setDoubleValue( atof( tokens[2].c_str() ) ); - } else if ( type == SGValue::STRING ) { - v->setStringValue( tokens[2] ); + } catch (...) { + // Ignore attempt to move past root node with ".." } - - // now fetch and write out the new value as confirmation - // of the change - string value = node.getStringValue ( tokens[1], "" ); - string tmp = tokens[1] + " = '" + value + "' ("; - tmp += getValueTypeString( node.getValue( tokens[1] ) ); - tmp += ")\n"; - - io->writestring( tmp.c_str() ); - } else { - string tmp = tokens[1] + " is unknown.\n"; - - io->writestring( tmp.c_str() ); + } + } else if ( command == "pwd" ) { + string ttt = node->getPath(); + if (ttt.empty()) { + ttt = "/"; } + push( ttt.c_str() ); + push( getTerminator() ); + } else if ( command == "get" || command == "show" ) { + if ( tokens.size() == 2 ) { + string tmp; + string value = node->getStringValue ( tokens[1].c_str(), "" ); + if ( mode == PROMPT ) { + tmp = tokens[1]; + tmp += " = '"; + tmp += value; + tmp += "' ("; + tmp += getValueTypeString( + node->getNode( tokens[1].c_str() ) ); + tmp += ")"; + } else { + tmp = value; + } + push( tmp.c_str() ); + push( getTerminator() ); + } + } else if ( command == "set" ) { + if ( tokens.size() >= 2 ) { + string value, tmp; + if ( tokens.size() == 3 ) { + value = tokens[2]; + } else { + value = ""; + } + node->getNode( tokens[1].c_str(), true ) + ->setStringValue(value.c_str()); + + if ( mode == PROMPT ) { + // now fetch and write out the new value as confirmation + // of the change + value = node->getStringValue ( tokens[1].c_str(), "" ); + tmp = tokens[1] + " = '" + value + "' ("; + tmp += getValueTypeString( node->getNode( tokens[1].c_str() ) ); + tmp += ")"; + push( tmp.c_str() ); + push( getTerminator() ); + } + } + } else if ( command == "reinit" ) { + if ( tokens.size() == 2 ) { + string tmp; + SGPropertyNode args; + for ( unsigned int i = 1; i < tokens.size(); ++i ) { + cout << "props: adding subsystem = " << tokens[i] << endl; + SGPropertyNode *node = args.getNode("subsystem", i-1, true); + node->setStringValue( tokens[i].c_str() ); + } + if ( !globals->get_commands() + ->execute( "reinit", &args) ) + { + SG_LOG( SG_GENERAL, SG_ALERT, + "Command " << tokens[1] << " failed."); + if ( mode == PROMPT ) { + tmp += "*failed*"; + push( tmp.c_str() ); + push( getTerminator() ); + } + } else { + if ( mode == PROMPT ) { + tmp += ""; + push( tmp.c_str() ); + push( getTerminator() ); + } + } + } + } else if ( command == "run" ) { + string tmp; + if ( tokens.size() >= 2 ) { + SGPropertyNode args; + if ( tokens[1] == "reinit" ) { + for ( unsigned int i = 2; i < tokens.size(); ++i ) { + cout << "props: adding subsystem = " << tokens[i] + << endl; + SGPropertyNode *node + = args.getNode("subsystem", i-2, true); + node->setStringValue( tokens[i].c_str() ); + } + } else if ( tokens[1] == "set-sea-level-air-temp-degc" ) { + for ( unsigned int i = 2; i < tokens.size(); ++i ) { + cout << "props: set-sl command = " << tokens[i] + << endl; + SGPropertyNode *node + = args.getNode("temp-degc", i-2, true); + node->setStringValue( tokens[i].c_str() ); + } + } else if ( tokens[1] == "set-outside-air-temp-degc" ) { + for ( unsigned int i = 2; i < tokens.size(); ++i ) { + cout << "props: set-oat command = " << tokens[i] + << endl; + SGPropertyNode *node + = args.getNode("temp-degc", i-2, true); + node->setStringValue( tokens[i].c_str() ); + } + } else if ( tokens[1] == "timeofday" ) { + for ( unsigned int i = 2; i < tokens.size(); ++i ) { + cout << "props: time of day command = " << tokens[i] + << endl; + SGPropertyNode *node + = args.getNode("timeofday", i-2, true); + node->setStringValue( tokens[i].c_str() ); + } + } + if ( !globals->get_commands() + ->execute(tokens[1].c_str(), &args) ) + { + SG_LOG( SG_GENERAL, SG_ALERT, + "Command " << tokens[1] << " failed."); + if ( mode == PROMPT ) { + tmp += "*failed*"; + push( tmp.c_str() ); + push( getTerminator() ); + } + } else { + if ( mode == PROMPT ) { + tmp += ""; + push( tmp.c_str() ); + push( getTerminator() ); + } + } + } else { + if ( mode == PROMPT ) { + tmp += "no command specified"; + push( tmp.c_str() ); + push( getTerminator() ); + } + } + } else if (command == "quit") { + close(); + shouldDelete(); + return; + } else if ( command == "data" ) { + mode = DATA; + } else if ( command == "prompt" ) { + mode = PROMPT; + } else { + const char* msg = "\ +Valid commands are:\r\n\ +\r\n\ +cd cd to a directory, '..' to move back\r\n\ +data switch to raw data mode\r\n\ +dump dump current state (in xml)\r\n\ +get show the value of a parameter\r\n\ +help show this help message\r\n\ +ls [] list directory\r\n\ +prompt switch to interactive mode (default)\r\n\ +pwd display your current path\r\n\ +quit terminate connection\r\n\ +run run built in command\r\n\ +set set to a new \r\n\ +show synonym for get\r\n"; + push( msg ); } - } else if ( command == "quit" ) { - close(); - } else { - io->writestring( "\n" ); - io->writestring( "Valid commands are:\n" ); - io->writestring( "\n" ); - io->writestring( "help show help message\n" ); - io->writestring( "ls list current directory\n" ); - io->writestring( "cd cd to a directory, '..' to move back\n" ); - io->writestring( "show show the value of a parameter\n" ); - io->writestring( "set set to a new \n" ); - io->writestring( "quit terminate connection\n" ); - io->writestring( "\n" ); } - string prompt = node.getPath(); - if ( prompt == "" ) { - prompt = "/"; + prompt: + if (mode == PROMPT) { + string prompt = node->getPath(); + if (prompt.empty()) { + prompt = "/"; + } + prompt += "> "; + push( prompt.c_str() ); } - prompt += "> "; - io->writestring( prompt.c_str() ); - return true; + buffer.remove(); } - -// process work for this port -bool FGProps::process() { - SGIOChannel *io = get_io_channel(); - - // cout << "processing incoming props command" << endl; - - if ( get_direction() == SG_IO_BI ) { - // cout << " (bi directional)" << endl; - while ( io->readline( buf, max_cmd_len ) > 0 ) { - FG_LOG( FG_IO, FG_ALERT, "Success reading data." ); - process_command( buf ); - } +/** + * + */ +FGProps::FGProps( const vector& tokens ) +{ + // tokens: + // props,port# + // props,medium,direction,hz,hostname,port#,style + if (tokens.size() == 2) { + port = atoi( tokens[1].c_str() ); + set_hz( 5 ); // default to processing requests @ 5Hz + } else if (tokens.size() == 7) { + char* endptr; + errno = 0; + int hz = strtol( tokens[3].c_str(), &endptr, 10 ); + if (errno != 0) { + SG_LOG( SG_IO, SG_ALERT, "I/O poll frequency out of range" ); + set_hz( 5 ); // default to processing requests @ 5Hz + } else { + SG_LOG( SG_IO, SG_INFO, "Setting I/O poll frequency to " + << hz << " Hz"); + set_hz( hz ); + } + port = atoi( tokens[5].c_str() ); } else { - FG_LOG( FG_IO, FG_ALERT, - "in or out direction not supported for FGProps." ); + throw FGProtocolConfigError( "FGProps: incorrect number of configuration arguments" ); } - - return true; } +/** + * + */ +FGProps::~FGProps() +{ +} -// close the channel -bool FGProps::close() { - SGIOChannel *io = get_io_channel(); - - set_enabled( false ); - - if ( ! io->close() ) { +/** + * + */ +bool +FGProps::open() +{ + if ( is_enabled() ) + { + SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel " + << "is already in use, ignoring" ); return false; } - cout << "successfully closed channel\n"; + netChannel::open(); + netChannel::bind( "", port ); + netChannel::listen( 5 ); + SG_LOG( SG_IO, SG_INFO, "Props server started on port " << port ); + set_enabled( true ); return true; } + +/** + * + */ +bool +FGProps::close() +{ + SG_LOG( SG_IO, SG_INFO, "closing FGProps" ); + return true; +} + +/** + * + */ +bool +FGProps::process() +{ + netChannel::poll(); + return true; +} + +/** + * + */ +void +FGProps::handleAccept() +{ + netAddress addr; + int handle = accept( &addr ); + SG_LOG( SG_IO, SG_INFO, "Props server accepted connection from " + << addr.getHost() << ":" << addr.getPort() ); + PropsChannel* channel = new PropsChannel(); + channel->setHandle( handle ); +}