Improve help and programmed answers output.
[anna.git] / example / diameter / launcher / main.cpp
index 2916704..35b283c 100644 (file)
@@ -42,6 +42,7 @@
 
 #include <string>
 #include <map>
+#include <deque>
 
 
 #include <anna/config/defines.hpp>
@@ -101,12 +102,104 @@ anna::diameter::comm::Message G_commMsg;
 anna::diameter::codec::Message G_codecMsg, G_codecAnsMsg;
 anna::Recycler<anna::diameter::comm::Message> G_commMessages; // create on requests forwards without programmed answer / release in answers forward
 
-
 // Auxiliary resources for answers programming
-typedef std::map < int /* message code */, anna::diameter::codec::Message* > reacting_answers_container;
-typedef std::map < int /* message code */, anna::diameter::codec::Message* >::iterator  reacting_answers_iterator;
-typedef std::map < int /* message code */, anna::diameter::codec::Message* >::const_iterator  reacting_answers_const_iterator;
-reacting_answers_container G_reactingAnswers2C, G_reactingAnswers2E;
+class ProgrammedAnswers {
+
+typedef std::deque<anna::diameter::codec::Message*> codec_messages_deque;
+typedef std::deque<anna::diameter::codec::Message*>::iterator codec_messages_deque_iterator;
+typedef std::deque<anna::diameter::codec::Message*>::const_iterator codec_messages_deque_const_iterator;
+typedef std::map < int /* message code */, codec_messages_deque* > reacting_answers_container;
+typedef std::map < int /* message code */, codec_messages_deque* >::iterator  reacting_answers_iterator;
+typedef std::map < int /* message code */, codec_messages_deque* >::const_iterator  reacting_answers_const_iterator;
+
+  reacting_answers_container a_deques;
+
+  public:
+    ProgrammedAnswers() {};
+    ~ProgrammedAnswers() { clear(); }
+
+    void clear () throw() {
+      for (reacting_answers_const_iterator it = a_deques.begin(); it != a_deques.end(); it++) {
+        anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
+        engine->releaseMessage(*(it->second->begin()));
+        delete(it->second);
+      }
+      a_deques.clear();
+    }
+
+    void dump () throw() {
+      std::string outfilename, xmlString;
+      for(reacting_answers_const_iterator it = a_deques.begin(); it != a_deques.end(); it++) {
+        int sequence = 1;
+        for(codec_messages_deque_const_iterator itm = it->second->begin(); itm != it->second->end(); itm++) {
+          // programmed_answer.<code>.<sequence>
+          outfilename = "programmed_answer.";
+          outfilename += anna::functions::asString(it->first);
+          outfilename += ".";
+          outfilename += anna::functions::asString(sequence++);
+          outfilename += ".xml";
+          std::ofstream outfile(outfilename.c_str(), std::ifstream::out);
+          xmlString =  (*itm)->asXMLString();
+          outfile.write(xmlString.c_str(), xmlString.size());
+          outfile.close();
+        }
+      }
+    }
+
+    void addMessage(int code, anna::diameter::codec::Message *message) throw() {
+      reacting_answers_const_iterator it = a_deques.find(code);
+      if (it != a_deques.end()) {
+        it->second->push_back(message);
+      }
+      else {
+        codec_messages_deque *deque = new codec_messages_deque;
+        a_deques[code] = deque;
+        deque->push_back(message);
+      }
+    }
+
+    anna::diameter::codec::Message* getMessage(int code) const throw() { //get the front message (begin()), returns NULL if deque is empty
+      anna::diameter::codec::Message *result = NULL;
+      reacting_answers_const_iterator it = a_deques.find(code);
+      if (it != a_deques.end()) {
+        if (!it->second->empty()) result = *(it->second->begin());
+      }
+      return result;
+    }
+
+    void nextMessage(int code) throw() { //pops the deque and release the message (when deque is not empty: deque::empty)
+      reacting_answers_const_iterator it = a_deques.find(code);
+      if (it != a_deques.end()) {
+        if (!it->second->empty()) {
+          anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
+          engine->releaseMessage(*(it->second->begin()));
+          it->second->pop_front();
+        }
+      }
+    }
+
+    std::string asString() const throw() {
+      std::string result = "No ocurrences found\n\n";
+      std::string s_code;
+      if(a_deques.size() != 0) {
+        result = "";
+        for(reacting_answers_const_iterator it = a_deques.begin(); it != a_deques.end(); it++) {
+          
+          s_code = "Answer code ";
+          s_code += anna::functions::asString(it->first);
+          result += anna::functions::highlightJustify(s_code);
+          for(codec_messages_deque_const_iterator itm = it->second->begin(); itm != it->second->end(); itm++) {
+            result += (*itm)->asXMLString();
+            result += "\n";
+          }
+          result += "\n";
+        }
+      }
+      return result;
+    }
+};
+
+ProgrammedAnswers G_reactingAnswers2C, G_reactingAnswers2E;
 
 
 
@@ -330,8 +423,6 @@ public:
   void resetCounters() throw();
   void signalUSR2() throw(anna::RuntimeException);
   std::string help() const throw();
-  std::string programmedAnswers2e() const throw();
-  std::string programmedAnswers2c() const throw();
 
   // helpers
   bool getDataBlockFromHexFile(const std::string &pathfile, anna::DataBlock &db) const throw();
@@ -666,7 +757,7 @@ std::string Launcher::help() const throw() {
   result += "\n establish as minimum), separate statistics analyzer per each resource, automatic CER/CEA and DWR/DWA";
   result += "\n generation, expiration control and many more features.";
   result += "\n";
-  result += "\nProcess traces are dump on \"launcher.traces\" and could have any trace level (POSIX levels), usually";
+  result += "\nProcess traces are dump on \"launcher.trace\" and could have any trace level (POSIX levels), usually";
   result += "\n 'debug' or 'warning'. See ANNA documentation for more details.";
   result += "\n";
   result += "\nAs any other ANNA process, context dump could be retrieved sending SIGUSR1 signal:";
@@ -754,10 +845,17 @@ std::string Launcher::help() const throw() {
   result += "\nsendxml2e|<source_file>    Sends xml source file (pathfile) through configured entity.";
   result += "\nsendxml2c|<source_file>    Sends xml source file (pathfile) to client.";
   result += "\nsendxml|<source_file>      Same as 'sendxml2e'.";
-  result += "\nanswerxml2e|[source_file]  Answer xml source file (pathfile) for corresponding request from entity.";
-  result += "\nanswerxml2c|[source_file]  Answer xml source file (pathfile) for corresponding request from client.";
+  result += "\nanswerxml2e|[source_file]  Answer xml source file (pathfile) for incoming request with same code from entity.";
+  result += "\n                           The answer is stored in a FIFO queue for a specific message code, then there are";
+  result += "\n                           as many queues as different message codes have been received.";
+  result += "\nanswerxml2c|[source_file]  Answer xml source file (pathfile) for incoming request with same code from client.";
+  result += "\n                           The answer is stored in a FIFO queue for a specific message code, then there are";
+  result += "\n                           as many queues as different message codes have been received.";
   result += "\nanswerxml|[source_file]    Same as 'answerxml2c'.";
-  result += "\n                           List programmed answers if no parameter provided.";
+  result += "\nanswerxml(2e/2c)           List programmed answers (to entity/client) if no parameter provided.";
+  result += "\nanswerxml(2e/2c)|dump      Write programmed answers (to entity/client) to file 'programmed_answer.<message code>.<sequence>',";
+  result += "\n                           where 'sequence' is the order of the answer in each FIFO code-queue of programmed answers.";
+  result += "\nanswerxml(2e/2c)|clear     Clear programmed answers (to entity/client).";
   result += "\n";
   result += "\nSend operations are available using hexadecimal content (hex formatted files) which also allow to test";
   result += "\nspecial scenarios (protocol errors):";
@@ -767,8 +865,8 @@ std::string Launcher::help() const throw() {
   result += "\nsendhex|<source_file>      Same as 'sendhex2e'.";
   result += "\n";
   result += "\nAnswer programming in hexadecimal is not really neccessary (you could use send primitives) and also";
-  result += "\nis intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
-  result += "\nsubscriber id, session id, etc.";
+  result += "\n is intended to be used with decoded messages in order to replace things like hop by hop, end to end,";
+  result += "\n subscriber id, session id, etc. Anyway you could use 'decode' operation and then program the xml created.";
   result += "\n";
   result += "\nIf a request is received, answer map (built with 'answerxml<[2c] or 2e>' operations) will be";
   result += "\n checked to find a corresponding programmed answer to be replied(*). If no ocurrence is found,";
@@ -776,6 +874,11 @@ std::string Launcher::help() const throw() {
   result += "\n or nothing but trace when no peer at that side is configured. Answer to client have sense when";
   result += "\n diameter server socket is configured, answer to entity have sense when entity does.";
   result += "\n";
+  result += "\nIn the most complete situation (process with both client and server side) there are internally";
+  result += "\n two maps with N FIFO queues, one for each different message code within programmed answers.";
+  result += "\nOne map is for answers towards the client, and the other is to react entity requests. Then in";
+  result += "\n each one we could program different answers corresponding to different request codes received.";
+  result += "\n";
   result += "\n(*) sequence values (hop-by-hop and end-to-end), Session-Id and Subscription-Id avps, are mirrored";
   result += "\n    to the peer which sent the request. If user wants to test a specific answer without changing it,";
   result += "\n    use sendxml/sendhex operations better than programming.";
@@ -871,39 +974,6 @@ std::string Launcher::help() const throw() {
 }
 
 
-std::string Launcher::programmedAnswers2c() const throw() {
-  std::string result = "\n";
-  result += "\n          ------------- CURRENT PROGRAMMED ANSWERS TO CLIENT -------------\n\n";
-
-  if(G_reactingAnswers2C.size() == 0) {
-    result += "No ocurrences found\n\n";
-  } else {
-    for(reacting_answers_const_iterator it = G_reactingAnswers2C.begin(); it != G_reactingAnswers2C.end(); it++) {
-      result += (*it).second->asXMLString();
-      result += "\n\n";
-    }
-  }
-
-  return result;
-}
-
-
-std::string Launcher::programmedAnswers2e() const throw() {
-  std::string result = "\n";
-  result += "\n\n          ------------- CURRENT PROGRAMMED ANSWERS TO ENTITY -------------\n\n";
-
-  if(G_reactingAnswers2E.size() == 0) {
-    result += "No ocurrences found\n\n";
-  } else {
-    for(reacting_answers_const_iterator it = G_reactingAnswers2E.begin(); it != G_reactingAnswers2E.end(); it++) {
-      result += (*it).second->asXMLString();
-      result += "\n\n";
-    }
-  }
-
-  return result;
-}
-
 void MyCommunicator::prepareAnswer(anna::diameter::codec::Message *answer, const anna::DataBlock &request) const throw() {
   // Sequence values (hop-by-hop and end-to-end), session-id and subscription-id avps, are mirrored to the peer which sent the request.
   // If user wants to test a specific answer without changing it, use send operations better than programming.
@@ -966,7 +1036,7 @@ using namespace anna::diameter;
 
 int main(int argc, const char** argv) {
   anna::Logger::setLevel(anna::Logger::Warning);
-  anna::Logger::initialize("launcher", new TraceWriter("launcher.traces", 2048000));
+  anna::Logger::initialize("launcher", new TraceWriter("launcher.trace", 2048000));
   anna::time::functions::initialize(); // before application instantiation (it have a anna::time object)
   anna::time::functions::setControlPoint(); // start control point (application lifetime)
   Launcher app;
@@ -1477,42 +1547,39 @@ throw(anna::RuntimeException) {
   // Stack:
   anna::diameter::codec::Engine *codecEngine = new anna::diameter::codec::Engine();
   anna::diameter::stack::Engine &stackEngine = anna::diameter::stack::Engine::instantiate();
-
-  try {
-    anna::diameter::stack::Dictionary * d = stackEngine.createDictionary(0 /* stack id */);
-    // Analyze comma-separated list:
-    anna::Tokenizer lst;
-    std::string dictionaryParameter = cl.getValue("dictionary");
-    lst.apply(dictionaryParameter, ",");
-
-    if(lst.size() >= 1) {  // always true (at least one, because -dictionary is mandatory)
-      anna::Tokenizer::const_iterator tok_min(lst.begin());
-      anna::Tokenizer::const_iterator tok_max(lst.end());
-      anna::Tokenizer::const_iterator tok_iter;
-      std::string pathFile;
-      d->allowUpdates();
-
-      for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
-        pathFile = anna::Tokenizer::data(tok_iter);
-        d->load(pathFile);
-      }
+  anna::diameter::stack::Dictionary * d = stackEngine.createDictionary(0 /* stack id; its value don't mind, is not used (ADL is monostack) */);
+  // Analyze comma-separated list:
+  anna::Tokenizer lst;
+  std::string dictionaryParameter = cl.getValue("dictionary");
+  lst.apply(dictionaryParameter, ",");
+
+  if(lst.size() >= 1) {  // always true (at least one, because -dictionary is mandatory)
+    anna::Tokenizer::const_iterator tok_min(lst.begin());
+    anna::Tokenizer::const_iterator tok_max(lst.end());
+    anna::Tokenizer::const_iterator tok_iter;
+    std::string pathFile;
+    d->allowUpdates();
+
+    for(tok_iter = tok_min; tok_iter != tok_max; tok_iter++) {
+      pathFile = anna::Tokenizer::data(tok_iter);
+      d->load(pathFile);
     }
+  }
 
-    codecEngine->setDictionary(d);
-    LOGDEBUG(anna::Logger::debug(codecEngine->asString(), ANNA_FILE_LOCATION));
+  codecEngine->setDictionary(d);
+  LOGDEBUG(anna::Logger::debug(codecEngine->asString(), ANNA_FILE_LOCATION));
 
-    if(lst.size() > 1) {
-      std::string all_in_one = "./dictionary-all-in-one.xml";
-      std::ofstream out(all_in_one, std::ifstream::out);
-      std::string buffer = d->asXMLString();
-      out.write(buffer.c_str(), buffer.size());
-      out.close();
-      std::cout << "Written accumulated '" << all_in_one << "' (provide it next time to be more comfortable)." << std::endl;
-    }
-  } catch(anna::RuntimeException &ex) {
-    ex.trace();
+  if(lst.size() > 1) {
+    std::string all_in_one = "./dictionary-all-in-one.xml";
+    std::ofstream out(all_in_one.c_str(), std::ifstream::out);
+    std::string buffer = d->asXMLString();
+    out.write(buffer.c_str(), buffer.size());
+    out.close();
+    std::cout << "Written accumulated '" << all_in_one << "' (provide it next time to be more comfortable)." << std::endl;
   }
 
+
+
   // Integration (validation 'Complete' for receiving messages) and debugging (validation also before encoding: 'Always').
   // If missing 'integrationAndDebugging', default behaviour at engine is: mode 'AfterDecoding', depth 'FirstError':
   if(cl.exists("integrationAndDebugging")) {
@@ -1700,7 +1767,7 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     std::string s_help = help();
     std::cout << s_help << std::endl;
     LOGINFORMATION(anna::Logger::information(s_help, ANNA_FILE_LOCATION));
-    response_content = "Help dumped on stdout and information-level traces (launcher.traces file)\n";
+    response_content = "Help dumped on stdout and information-level traces (launcher.trace file)\n";
     return;
   }
 
@@ -1990,7 +2057,17 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     if(!localServer)
       throw anna::RuntimeException("Operation not applicable (no own diameter server has been configured)", ANNA_FILE_LOCATION);
 
-    if(param1 != "") {
+    if(param1 == "") { // programmed answers FIFO's to stdout
+      std::cout << std::endl << std::endl;
+      std::cout << "          ------------- CURRENT PROGRAMMED ANSWERS TO CLIENT -------------\n\n";
+      std::cout << G_reactingAnswers2C.asString() << std::endl;
+      response_content = "Programmed answers dumped on stdout\n";
+      return;
+    } else if (param1 == "clear") {
+      G_reactingAnswers2C.clear();
+    } else if (param1 == "dump") {
+      G_reactingAnswers2C.dump();
+    } else {
       anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
       anna::diameter::codec::Message *message = engine->createMessage(param1);
       LOGDEBUG
@@ -2002,18 +2079,8 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
         throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
 
       int code = message->getId().first;
-      reacting_answers_const_iterator it = G_reactingAnswers2C.find(code);
-
-      if(it != G_reactingAnswers2C.end()) {  // found: replace
-        LOGDEBUG(anna::Logger::debug("Replacing formerly programed answer...", ANNA_FILE_LOCATION));
-        engine->releaseMessage((*it).second);
-      }
-
-      G_reactingAnswers2C[code] = message;
-    } else { // answers query on stdout
-      std::cout << programmedAnswers2c() << std::endl;
-      response_content = "Programmed answers dumped on stdout\n";
-      return;
+      LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to client' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
+      G_reactingAnswers2C.addMessage(code, message);
     }
   } else if(opType == "answerxml2e") {
     anna::diameter::comm::Entity *entity = getEntity();
@@ -2021,7 +2088,17 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
     if(!entity)
       throw anna::RuntimeException("Operation not applicable (no diameter entity has been configured)", ANNA_FILE_LOCATION);
 
-    if(param1 != "") {
+    if(param1 == "") { // programmed answers FIFO's to stdout
+      std::cout << std::endl << std::endl;
+      std::cout << "          ------------- CURRENT PROGRAMMED ANSWERS TO ENTITY -------------\n\n";
+      std::cout << G_reactingAnswers2E.asString() << std::endl;
+      response_content = "Programmed answers dumped on stdout\n";
+      return;
+    } else if (param1 == "clear") {
+      G_reactingAnswers2E.clear();
+    } else if (param1 == "dump") {
+      G_reactingAnswers2E.dump();
+    } else { 
       anna::diameter::codec::Engine *engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION);
       anna::diameter::codec::Message *message = engine->createMessage(param1);
       LOGDEBUG
@@ -2033,18 +2110,8 @@ void Launcher::eventOperation(const std::string &operation, std::string &respons
         throw anna::RuntimeException("Cannot program diameter requests. Answer type must be provided", ANNA_FILE_LOCATION);
 
       int code = message->getId().first;
-      reacting_answers_const_iterator it = G_reactingAnswers2E.find(code);
-
-      if(it != G_reactingAnswers2E.end()) {  // found: replace
-        LOGDEBUG(anna::Logger::debug("Replacing formerly programed answer...", ANNA_FILE_LOCATION));
-        engine->releaseMessage((*it).second);
-      }
-
-      G_reactingAnswers2E[code] = message;
-    } else { // answers query on stdout
-      std::cout << programmedAnswers2e() << std::endl;
-      response_content = "Programmed answers dumped on stdout\n";
-      return;
+      LOGDEBUG(anna::Logger::debug("Adding a new programed 'answer to entity' to the FIFO queue corresponding to its message code ...", ANNA_FILE_LOCATION));
+      G_reactingAnswers2E.addMessage(code, message);
     }
   } else {
     LOGWARNING(anna::Logger::warning(help(), ANNA_FILE_LOCATION));
@@ -2187,10 +2254,8 @@ throw(anna::RuntimeException) {
 
   // Lookup reacting answers list:
   int code = cid.first;
-  reacting_answers_const_iterator it = G_reactingAnswers2E.find(code);
-
-  if(it != G_reactingAnswers2E.end()) {
-    anna::diameter::codec::Message *answer_message = (*it).second;
+  anna::diameter::codec::Message *answer_message = G_reactingAnswers2E.getMessage(code);
+  if (answer_message) {
     // Prepare answer:
     my_app.getCommunicator()->prepareAnswer(answer_message, message);
 
@@ -2204,26 +2269,38 @@ throw(anna::RuntimeException) {
 
       if(my_app.logEnabled()) my_app.writeLogFile(*answer_message, "send2eError", clientSession->asString());
     }
-  } else { // not found: forward to client (if exists)
-    // Forward to client:
-    anna::diameter::comm::LocalServer *localServer = my_app.getDiameterLocalServer();
 
-    if(localServer && (cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) /* don't forward CER */) {
-      try {
-        anna::diameter::comm::Message *msg = G_commMessages.create();
-        msg->setBody(message);
-        msg->setRequestClientSessionKey(clientSession->getKey());
-        bool success = localServer->send(msg);
+    // Pop front the reacting answer:
+    G_reactingAnswers2E.nextMessage(code);
+    return;
+  }
 
-        // Detailed log:
-        if(my_app.logEnabled()) {
-          anna::diameter::comm::ServerSession *usedServerSession = localServer->getLastUsedResource();
-          std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // esto no deberia ocurrir
-          my_app.writeLogFile(message, (success ? "fwd2c" : "fwd2cError"), detail);
-        }
-      } catch(anna::RuntimeException &ex) {
-        ex.trace();
+  LOGDEBUG
+  (
+    std::string msg = "No answers programmed (maybe sold out) for request coming from entity: ";
+    msg += anna::diameter::functions::commandIdAsPairString(cid);
+    anna::Logger::debug(msg, ANNA_FILE_LOCATION);
+  );
+
+  // not found: forward to client (if exists)
+  // Forward to client:
+  anna::diameter::comm::LocalServer *localServer = my_app.getDiameterLocalServer();
+
+  if(localServer && (cid != anna::diameter::helpers::base::COMMANDID__Capabilities_Exchange_Request) /* don't forward CER */) {
+    try {
+      anna::diameter::comm::Message *msg = G_commMessages.create();
+      msg->setBody(message);
+      msg->setRequestClientSessionKey(clientSession->getKey());
+      bool success = localServer->send(msg);
+
+      // Detailed log:
+      if(my_app.logEnabled()) {
+        anna::diameter::comm::ServerSession *usedServerSession = localServer->getLastUsedResource();
+        std::string detail = usedServerSession ? usedServerSession->asString() : "<null server session>"; // esto no deberia ocurrir
+        my_app.writeLogFile(message, (success ? "fwd2c" : "fwd2cError"), detail);
       }
+    } catch(anna::RuntimeException &ex) {
+      ex.trace();
     }
   }
 }
@@ -2367,10 +2444,10 @@ throw(anna::RuntimeException) {
 
   // If no answer is programmed and entity is configured, the failed request would be forwarded even being wrong (delegates at the end point)
   int code = cid.first;
-  reacting_answers_const_iterator it = G_reactingAnswers2C.find(code);
-  bool programmed = (it != G_reactingAnswers2C.end());
-  anna::diameter::comm::Entity *entity = my_app.getEntity();
+  anna::diameter::codec::Message *programmed_answer = G_reactingAnswers2C.getMessage(code);
+  bool programmed = (programmed_answer != NULL);
 
+  anna::diameter::comm::Entity *entity = my_app.getEntity();
   if(!programmed && entity) {  // forward condition (no programmed answer + entity available)
     anna::diameter::comm::Message *msg = G_commMessages.create();
     msg->setBody(message);
@@ -2406,7 +2483,7 @@ throw(anna::RuntimeException) {
   // Programmed answer only when all is ok
   if(analysisOK) {
     if(programmed) {
-      answer_message = (*it).second;
+      answer_message = programmed_answer;
       // Prepare answer:
       my_app.getCommunicator()->prepareAnswer(answer_message, message);
     } else return; // nothing done
@@ -2431,6 +2508,9 @@ throw(anna::RuntimeException) {
 
   // Restore validation mode
   codecEngine->setValidationMode(backupVM);
+
+  // Pop front the reacting answer:
+  if(analysisOK && programmed) G_reactingAnswers2C.nextMessage(code);
 }
 
 void MyLocalServer::eventResponse(const anna::diameter::comm::Response &response)