Changed LICENSE. Now referenced to web site and file on project root directory
[anna.git] / source / diameter / codec / Message.cpp
index 6490b81..5f21bb2 100644 (file)
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not 'N' Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// https://bitbucket.org/testillano/anna
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 // Local
@@ -59,6 +31,7 @@
 
 // STL
 #include <string>
+#include <vector>
 
 
 using namespace anna;
@@ -226,6 +199,20 @@ void Message::setId(const char *name) throw(anna::RuntimeException) {
 }
 
 
+//------------------------------------------------------------------------------
+//-------------------------------------------------- Message::setApplicationId()
+//------------------------------------------------------------------------------
+void Message::setApplicationId(U32 aid) throw() {
+  a_applicationId = aid;
+
+  // Default behaviour:
+  if (!getEngine()->hasSelectStackWithApplicationId()) return;
+
+  // Adapts for Application-ID stack identifier:
+  getEngine()->setDictionary(aid);
+}
+
+
 //------------------------------------------------------------------------------
 //------------------------------------------------------------ Message::addAvp()
 //------------------------------------------------------------------------------
@@ -293,14 +280,14 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
   //
   // VALIDATION PHASE
   // Launch exception on first validation error (validateAll == false), or log warning reporting all validation errors when
-  //  complete validation is desired (validateAll == true, engine default) launching a final exception like "decoded an invalid message".
+  //  complete validation is desired (validateAll == true, engine default) launching a final exception like "the decoded message is invalid".
   // OAM
   OamModule &oamModule = OamModule::instantiate();
 
   if(db.getSize() < HeaderLength) {
     oamModule.activateAlarm(OamModule::Alarm::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
     oamModule.count(OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
-    // DIAMETER_INVALID_MESSAGE_LENGTH; // no podré construir un answer fiable, así que no registro el result-code
+    // DIAMETER_INVALID_MESSAGE_LENGTH; // no podr� construir un answer fiable, as� que no registro el result-code
     throw anna::RuntimeException("Not enough bytes to cover message header length (20 bytes)", ANNA_FILE_LOCATION);
   }
 
@@ -330,9 +317,9 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
 
   U24 code = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
 
-  setId(CommandId(code, requestBit() /* based on a_flags */));
+  a_id = CommandId(code, requestBit() /* based on a_flags */);
 
-  a_applicationId = DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32);
+  setApplicationId(DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32)); // centralize set, because it could be used for stack selection.
 
   a_hopByHop = DECODE4BYTES_INDX_VALUETYPE(buffer, 12, U32);
 
@@ -369,17 +356,17 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
   Avp* avp;
   anna::DataBlock db_aux;
 
+  // Parent information:
+  parent_t parent;
+  parent.setMessage(a_id);
+
+
   while(avpPos < dataBytes) {
     try {
       avp =  getEngine()->allocateAvp();
       db_aux.assign(startData + avpPos, dataBytes - avpPos /* is valid to pass total length (indeed i don't know the real avp length) because it will be limited and this has deep copy disabled (no memory is reserved) */);
-      avp -> decode(db_aux, answer);
+      avp -> decode(db_aux, parent, answer);
     } catch(anna::RuntimeException &ex) {
-      if(answer) {
-        answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE); // unspecified error ...
-        answer->setNewFailedAvp(avp->getId());
-      }
-
       getEngine()->releaseAvp(avp);
       LOGWARNING(
         anna::Logger::warning(ex.getText(), ANNA_FILE_LOCATION);
@@ -408,7 +395,7 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
 
   if((vmode == Engine::ValidationMode::AfterDecoding) || (vmode == Engine::ValidationMode::Always))
     if(!valid(answer))
-      throw anna::RuntimeException("Decoded an invalid message. See previous report on warning-level traces", ANNA_FILE_LOCATION);
+      throw anna::RuntimeException("The decoded message is invalid. See previous report on warning-level traces", ANNA_FILE_LOCATION);
 }
 
 
@@ -457,14 +444,55 @@ int Message::getResultCode() const throw() {
 
 
 //------------------------------------------------------------------------------
-//------------------------------------------------------ Message::addFailedAVP()
+//------------------------------------------------------ Message::setFailedAvp()
 //------------------------------------------------------------------------------
-Avp * Message::addFailedAVP() throw() {
-  Avp *result = getAvp(helpers::base::AVPID__Failed_AVP, 1, anna::Exception::Mode::Ignore);
+void Message::setFailedAvp(const parent_t &parent, AvpId wrong, const char *wrongName) throw(anna::RuntimeException) {
 
-  if(!result) result = addAvp(helpers::base::AVPID__Failed_AVP);
+  if(isRequest()) return;
 
-  return result;
+// RFC 6733:
+//
+//  7.5.  Failed-AVP AVP
+//
+//     The Failed-AVP AVP (AVP Code 279) is of type Grouped and provides
+//     debugging information in cases where a request is rejected or not
+//     fully processed due to erroneous information in a specific AVP.  The
+//     value of the Result-Code AVP will provide information on the reason
+//     for the Failed-AVP AVP.  A Diameter answer message SHOULD contain an
+//     instance of the Failed-AVP AVP that corresponds to the error
+//     indicated by the Result-Code AVP.  For practical purposes, this
+//     Failed-AVP would typically refer to the first AVP processing error
+//     that a Diameter node encounters.
+
+  // Although the Failed-AVP definition has cardinality 1* and Failed-AVP itself is defined in
+  // most of the command codes as *[Failed-AVP], i think this is not a deliberate ambiguity.
+  // Probably the RFC wants to give freedom to the application layer, but it is recommended to
+  // have only one child (wrong avp) inside a unique message Failed-AVP to ease the Result-Code
+  // correspondence. Anyway, this behaviour could be easily  opened commenting condition block (*).
+  Avp *theFailedAvp = getAvp(helpers::base::AVPID__Failed_AVP, 1, anna::Exception::Mode::Ignore);
+  if (theFailedAvp) {
+       LOGDEBUG(anna::Logger::debug("Failed-AVP has already been added. RFC 6733 Section 7.5 recommends to store only the first error found", ANNA_FILE_LOCATION));
+    return;
+  }
+
+  // Section 7.5 RFC 6733: A Diameter message SHOULD contain one Failed-AVP AVP
+  theFailedAvp = addAvp(helpers::base::AVPID__Failed_AVP);
+  Avp *leaf = theFailedAvp;
+
+  LOGDEBUG(
+    std::string msg = "Adding to Failed-AVP, the wrong avp ";
+    msg += wrongName ? wrongName : (anna::diameter::functions::avpIdAsPairString(wrong));
+    msg += " found inside ";
+    msg += parent.asString();
+
+    anna::Logger::debug(msg, ANNA_FILE_LOCATION);
+  );
+
+  std::vector<AvpId>::const_iterator it;
+  for(it = parent.AvpsId.begin(); it != parent.AvpsId.end(); it++)
+       leaf = leaf->addAvp(*it);
+
+  leaf->addAvp(wrong);
 }
 
 
@@ -480,7 +508,8 @@ void Message::setStandardToAnswer(const Message &request, const std::string &ori
   const Avp *reqSessionId = request.getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore);
 
   if(reqSessionId)
-    addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
+       if(!getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore))
+      addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
 
   // Origin-Host & Realm
   if(!getAvp(helpers::base::AVPID__Origin_Host, 1, anna::Exception::Mode::Ignore))
@@ -543,7 +572,6 @@ bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
   OamModule &oamModule = OamModule::instantiate();
   // Dictionary stack command:
   const stack::Command *stackCommand = getStackCommand();
-  std::string me;
   // Only build answer for a request:
   Message *answer = isRequest() ? ptrAnswer : NULL;
 
@@ -551,7 +579,7 @@ bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
 
   if(!stackCommand) {
     // OAM
-    me = anna::diameter::functions::commandIdAsPairString(a_id);
+    std::string me = anna::diameter::functions::commandIdAsPairString(a_id);
     oamModule.activateAlarm(OamModule::Alarm::MessageValidation__UnknownOperation__s__UnableToValidate, STRING_WITH_QUOTATION_MARKS__C_STR(me));
     oamModule.count(OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate);
 
@@ -561,7 +589,10 @@ bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
     return false;
   }
 
-  me = stackCommand->getName();
+  // Parent information:
+  parent_t me;
+  me.setMessage(a_id, stackCommand->getName().c_str());
+
   //////////////////////////////
   // Flags coherence checking //
   //////////////////////////////
@@ -570,12 +601,12 @@ bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
 
   if(!result) {
     // OAM & Depth management
-    oamModule.activateAlarm(OamModule::Alarm::MessageValidation__Operation__s__HaveIncoherentFlags__d__, STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags);
+    oamModule.activateAlarm(OamModule::Alarm::MessageValidation__Operation__s__HaveIncoherentFlags__d__, STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags);
     oamModule.count(OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags);
 
     if(answer) answer->setResultCode(rc);
 
-    getEngine()->validationAnomaly(anna::functions::asString("Operation %s have incoherent flags (%d)", STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags));
+    getEngine()->validationAnomaly(anna::functions::asString("Operation %s have incoherent flags (%d)", STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags));
   }
 
   ////////////////////
@@ -600,7 +631,7 @@ const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
   // Pre-Validation
   Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
 
-  if((vmode == Engine::ValidationMode::BeforeCoding) || (vmode == Engine::ValidationMode::Always)) {
+  if((vmode == Engine::ValidationMode::BeforeEncoding) || (vmode == Engine::ValidationMode::Always)) {
     if(!valid())
       throw anna::RuntimeException("Try to encode an invalid message. See previous report on warning-level traces", ANNA_FILE_LOCATION);
   }
@@ -608,7 +639,7 @@ const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
   // Pre-Fixing
   Engine::FixMode::_v fmode = getEngine()->getFixMode();
 
-  if((fmode == Engine::FixMode::BeforeCoding) || (fmode == Engine::FixMode::Always)) fix();
+  if((fmode == Engine::FixMode::BeforeEncoding) || (fmode == Engine::FixMode::Always)) fix();
 
   // Trace
   LOGDEBUG(
@@ -711,6 +742,9 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   int i_aux;
   unsigned int u_aux;
 
+  // Clear the message
+  clear();
+
   if(version) {
     i_aux = version->getIntegerValue();
 
@@ -723,6 +757,10 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
     a_version = i_aux;
   }
 
+  // Application-id
+  // This is called before any operation which needs to know about the stack elements (this could set the dictionary)
+  setApplicationId(appid->getIntegerValue());
+
   // Dictionary
   const stack::Dictionary * dictionary = getEngine()->getDictionary();
   const stack::Command *stackCommand = NULL;
@@ -752,7 +790,7 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
 
-    setId(stackCommand->getId());
+    setId(stackCommand->getId(), false /* don't clear */);
     // 'P', 'E' and 'T' flags:
     bool activateP = pbit ? (pbit->getValue() == "yes") : false;
     bool activateE = ebit ? (ebit->getValue() == "yes") : false;
@@ -803,31 +841,22 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
     a_flags = i_aux;
     int flagsBCK = a_flags;
     // Final assignments
-    setId(CommandId(u_code, requestBit() /* based on a_flags */));
+    a_id = CommandId(u_code, requestBit() /* based on a_flags */);
     // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
     a_flags = flagsBCK;
   }
 
-  // Application-id
-  u_aux = appid->getIntegerValue();
-
-  if(u_aux < 0) {
-    std::string msg = "Error processing command <application-id '"; msg += appid->getValue();
-    msg += "': negative values are not allowed";
-    throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
-  }
-
-  setApplicationId(u_aux);
-
   // Hob-by-hop-id
   if(hbh) {
     u_aux = hbh->getIntegerValue();
 
+    /*
     if(u_aux < 0) {
       std::string msg = "Error processing command <hop-by-hop-id '"; msg += hbh->getValue();
       msg += "': negative values are not allowed";
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
+    */
   } else u_aux = 0;
 
   setHopByHop(u_aux);
@@ -836,11 +865,13 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   if(ete) {
     u_aux = ete->getIntegerValue();
 
+    /*
     if(u_aux < 0) {
       std::string msg = "Error processing command <end-to-end-id '"; msg += ete->getValue();
       msg += "': negative values are not allowed";
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
+    */
   } else u_aux = 0;
 
   setEndToEnd(u_aux);