source/diameter/codec/Avp.cpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // http://redmine.teslayout.com/projects/anna-suite
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     *  Neither the name of the copyright holder nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 // Local
  38 #include <anna/diameter/codec/Avp.hpp>
  39 #include <anna/diameter/codec/Format.hpp>
  40
  41 #include <anna/config/defines.hpp> // general types, decoding helpers (DECODE[2/3/4]BYTES_INDX_VALUETYPE), etc.
  42 #include <anna/diameter/functions.hpp>
  43 #include <anna/diameter/helpers/defines.hpp>
  44 #include <anna/diameter/codec/basetypes/basetypes.hpp>
  45 #include <anna/diameter/codec/functions.hpp> // REQUIRED_WORDS
  46 #include <anna/diameter/codec/OamModule.hpp>
  47 #include <anna/diameter/stack/Avp.hpp>
  48 #include <anna/diameter/stack/Format.hpp>
  49 #include <anna/diameter/stack/Dictionary.hpp>
  50 #include <anna/diameter/stack/Engine.hpp>
  51 #include <anna/diameter/codec/Engine.hpp>
  52 #include <anna/core/functions.hpp>
  53 #include <anna/core/util/RegularExpression.hpp>
  54
  55 #include <anna/core/tracing/Logger.hpp>
  56 #include <anna/core/functions.hpp>
  57 #include <anna/core/tracing/TraceMethod.hpp>
  58 #include <anna/xml/xml.hpp>
  59
  60 // STL
  61 #include <map>
  62
  63
  64 using namespace anna;
  65 using namespace anna::diameter::codec;
  66
  67
  68 //static
  69 namespace anna {
  70
  71 namespace diameter {
  72
  73 namespace codec {
  74 const int Avp::HeaderLengthVactive(12);
  75 const int Avp::HeaderLengthVinactive(8);
  76 const U8 Avp::VBitMask(0x80);
  77 const U8 Avp::MBitMask(0x40);
  78 const U8 Avp::PBitMask(0x20);
  79 }
  80 }
  81 }
  82
  83 //------------------------------------------------------------------------------
  84 //------------------------------------------------------------------- Avp::Avp()
  85 //------------------------------------------------------------------------------
  86 Avp::Avp() {
  87   initialize();
  88 }
  89
  90
  91 //------------------------------------------------------------------------------
  92 //------------------------------------------------------------------- Avp::Avp()
  93 //------------------------------------------------------------------------------
  94 Avp::Avp(AvpId id) {
  95   initialize();
  96   setId(id);
  97 }
  98
  99
 100 //------------------------------------------------------------------------------
 101 //------------------------------------------------------------------ Avp::~Avp()
 102 //------------------------------------------------------------------------------
 103 Avp::~Avp() {
 104   clear();
 105 }
 106
 107
 108 //------------------------------------------------------------------------------
 109 //------------------------------------------------------------- Avp::getEngine()
 110 //------------------------------------------------------------------------------
 111 Engine * Avp::getEngine() const throw(anna::RuntimeException) {
 112   return a_engine ? a_engine : (a_engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION));
 113 }
 114
 115
 116 //------------------------------------------------------------------------------
 117 //------------------------------------------------------------ Avp::initialize()
 118 //------------------------------------------------------------------------------
 119 void Avp::initialize() throw() {
 120   a_engine = NULL;
 121   a_id = helpers::AVPID__AVP; // (0,0)
 122   a_flags = 0x00;
 123   a_insertionPositionForChilds = 0;
 124   a_OctetString = NULL;
 125   a_Integer32 = NULL;
 126   a_Integer64 = NULL;
 127   a_Unsigned32 = NULL;
 128   a_Unsigned64 = NULL;
 129   a_Float32 = NULL;
 130   a_Float64 = NULL;
 131   //a_avps.clear();
 132   a_Address = NULL;
 133   a_Time = NULL;
 134   a_UTF8String = NULL;
 135   a_DiameterIdentity = NULL;
 136   a_DiameterURI = NULL;
 137   a_Enumerated = NULL;
 138   a_IPFilterRule = NULL;
 139   a_QoSFilterRule = NULL;
 140   a_Unknown = NULL;
 141   //a_finds.clear();
 142   /////////////////////
 143   // Format specific //
 144   /////////////////////
 145   initializeByFormat();
 146 }
 147
 148
 149 //------------------------------------------------------------------------------
 150 //----------------------------------------------------------------- Avp::clear()
 151 //------------------------------------------------------------------------------
 152 void Avp::clear() throw(anna::RuntimeException) {
 153   delete a_OctetString;
 154   delete a_Integer32;
 155   delete a_Integer64;
 156   delete a_Unsigned32;
 157   delete a_Unsigned64;
 158   delete a_Float32;
 159   delete a_Float64;
 160
 161   for(avp_iterator it = avp_begin(); it != avp_end(); it++) { /*avp(it)->clear(); */getEngine()->releaseAvp(avp(it)); }
 162
 163   a_avps.clear();
 164   delete a_Address;
 165   delete a_Time;
 166   delete a_UTF8String;
 167   delete a_DiameterIdentity;
 168   delete a_DiameterURI;
 169   delete a_Enumerated;
 170   delete a_IPFilterRule;
 171   delete a_QoSFilterRule;
 172   delete a_Unknown;
 173   // Cache system:
 174   a_finds.clear();
 175   /////////////////////
 176   // Format specific //
 177   /////////////////////
 178   clearByFormat();
 179   // Initialize:
 180   initialize();
 181 }
 182
 183
 184 //------------------------------------------------------------------------------
 185 //-------------------------------------------------------------- Avp::avp_find()
 186 //------------------------------------------------------------------------------
 187 avp_iterator Avp::avp_find(avp_container &avps, AvpId id, unsigned int position) throw() {
 188   int match = 0;
 189   Avp *aux;
 190
 191   for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
 192     aux = (*it).second;
 193
 194     if(aux && (aux->getId() == id)) {
 195       match++;
 196
 197       if(match == position) return it;
 198     }
 199   }
 200
 201   return avps.end();
 202 }
 203
 204
 205 //------------------------------------------------------------------------------
 206 //---------------------------------------------------------------- Avp::addAvp()
 207 //------------------------------------------------------------------------------
 208 Avp * Avp::addAvp(avp_container &avps, int &insertionPositionForChilds, AvpId id, Engine *engine) throw() {
 209   Avp * result = engine->allocateAvp();
 210   result->setId(id);
 211   addChild(avps, insertionPositionForChilds, result);
 212   return result;
 213 }
 214
 215
 216 //------------------------------------------------------------------------------
 217 //------------------------------------------------------------- Avp::removeAvp()
 218 //------------------------------------------------------------------------------
 219 bool Avp::removeAvp(avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine) throw() {
 220   bool removed = false;
 221   bool do_remove = true;
 222   int position = ocurrence;
 223
 224   if(position < 0) {  /* reversed access */
 225     position = countAvp(avps, id) + 1 + position;
 226
 227     // Special cases -> 0 and negative results:
 228     // (1) User wants to remove the last, but no avp is found: position = 0 + 1 - 1 = 0 (would removes all but, no avp will be found: return now)
 229     // (2) User wants to remove some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (would removes all !!!: return to avoid unexpected behaviour)
 230     // (2) User wants to remove some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
 231     if(position <= 0) do_remove = false;
 232   }
 233
 234   if(do_remove) {
 235     int n = position ? position : 1 /* will search always the first and remove, the first and remove, the first and remove ... */;
 236     avp_iterator it;
 237
 238     while((it = avp_find(avps, id, n)) != avps.end()) {
 239       engine->releaseAvp((*it).second);
 240       avps.erase(it);
 241       removed = true;
 242
 243       if(position) break;
 244     }
 245   }
 246
 247   if(removed) {
 248     // Cache system reset (remove will invalidate cached findings):
 249     finds.clear();
 250     LOGDEBUG(
 251       const stack::Avp *stackAvp = getStackAvp(id, engine);
 252       std::string msg = "Removed Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 253       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 254       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 255     );
 256   } else {
 257     LOGDEBUG(
 258       const stack::Avp *stackAvp = getStackAvp(id, engine);
 259       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 260       msg += anna::functions::asString(" with provided ocurrence (%d), in order to be removed", ocurrence);
 261       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 262     );
 263   }
 264
 265   return removed;
 266 }
 267
 268
 269 //------------------------------------------------------------------------------
 270 //-------------------------------------------------------------- Avp::countAvp()
 271 //------------------------------------------------------------------------------
 272 int Avp::countAvp(const avp_container &avps, AvpId id) throw() {
 273   int result = 0;
 274   const_avp_iterator it;
 275
 276   while((it = avp_find(avps, id, result + 1)) != avps.end()) result++;
 277
 278   return result;
 279 }
 280
 281
 282 //------------------------------------------------------------------------------
 283 //-------------------------------------------------------------- Avp::firstAvp()
 284 //------------------------------------------------------------------------------
 285 const Avp* Avp::firstAvp(const avp_container &avps, AvpId id) throw() {
 286   const_avp_iterator it = avp_find(avps, id, 1);
 287
 288   if(it != avps.end())
 289     return (*it).second;
 290
 291   return NULL;
 292 }
 293
 294
 295 //------------------------------------------------------------------------------
 296 //----------------------------------------------------------- Avp::countChilds()
 297 //------------------------------------------------------------------------------
 298 int Avp::countChilds(const avp_container &avps) throw() {
 299   return avps.size();
 300 }
 301
 302
 303 //------------------------------------------------------------------------------
 304 //---------------------------------------------------------------- Avp::getAvp()
 305 //------------------------------------------------------------------------------
 306 const Avp *Avp::getAvp(const avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine, anna::Exception::Mode::_v emode) throw(anna::RuntimeException) {
 307   if(ocurrence == 0) {
 308     LOGDEBUG(anna::Logger::debug("Ocurrence number zero has no sense. NULL returned.", ANNA_FILE_LOCATION));
 309     return NULL;
 310   }
 311
 312   bool do_search = true;
 313   bool cached;
 314   int position = ocurrence;
 315
 316   if(position < 0) {  /* reversed access */
 317     position = countAvp(avps, id) + 1 + position;
 318
 319     // Special cases -> 0 and negative results:
 320     // (1) User wants to get the last, but no avp is found: position = 0 + 1 - 1 = 0 (can't find 0-position ...)
 321     // (2) User wants to get some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (can't find 0-position ...)
 322     // (2) User wants to get some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
 323     if(position <= 0) do_search = false;
 324   }
 325
 326   const Avp * result = NULL;
 327
 328   if(do_search) {
 329     // Search at cache finds:
 330     find_key key(id, position);
 331     find_iterator fit = finds.find(key);
 332     cached = (fit != finds.end());
 333
 334     if(cached) {
 335       result = (*fit).second;
 336     } else {
 337       const_avp_iterator it = avp_find(avps, id, position);
 338
 339       if(it != avps.end()) {
 340         result = (*it).second;
 341         finds[key] = const_cast<Avp*>(result); // store in cache
 342       }
 343     }
 344   }
 345
 346   // Avp found:
 347   if(result) {
 348     LOGDEBUG(
 349       const stack::Avp *stackAvp = getStackAvp(id, engine);
 350       std::string msg = "Found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 351       msg += anna::functions::asString(" with provided ocurrence (%d) which was ", ocurrence);
 352       msg += cached ? "already cached:\n" : "the first search, now cached:\n";
 353       msg += result->asXMLString();
 354       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 355     );
 356     return result;
 357   }
 358
 359   // Avp not found:
 360   switch(emode) {
 361   case anna::Exception::Mode::Throw: {
 362     const stack::Avp *stackAvp = getStackAvp(id, engine);
 363     std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 364     msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 365     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 366     break;
 367   }
 368   case anna::Exception::Mode::Trace: {
 369     LOGWARNING(
 370       const stack::Avp *stackAvp = getStackAvp(id, engine);
 371       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 372       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 373       anna::Logger::warning(msg, ANNA_FILE_LOCATION);
 374     );
 375     break;
 376   }
 377   case anna::Exception::Mode::Ignore: {
 378     LOGDEBUG(
 379       const stack::Avp *stackAvp = getStackAvp(id, engine);
 380       std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
 381       msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
 382       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 383     );
 384     break;
 385   }
 386   }
 387
 388   return NULL;
 389 }
 390
 391
 392 //------------------------------------------------------------------------------
 393 //--------------------------------------------------------------- Avp::_getAvp()
 394 //------------------------------------------------------------------------------
 395 const Avp *Avp::_getAvp(AvpId id, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
 396   // Dictionary stack avp and format (this):
 397   const stack::Avp *stackAvp = getStackAvp();
 398   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 399
 400   if(!stackFormat || !stackFormat->isGrouped())
 401     throw anna::RuntimeException("This method only applies over grouped avps.", ANNA_FILE_LOCATION);
 402
 403   return getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
 404 }
 405
 406
 407 //------------------------------------------------------------------------------
 408 //---------------------------------------------------------- Avp::assertFormat()
 409 //------------------------------------------------------------------------------
 410 void Avp::assertFormat(const std::string &name) const throw(anna::RuntimeException) {
 411   // Dictionary stack avp and format:
 412   const stack::Avp *stackAvp = getStackAvp();
 413   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 414   std::string format = stackFormat ? stackFormat->getName() : "Unknown";
 415
 416   if(format != name) {
 417     std::string msg = "The Avp ";
 418     msg += anna::diameter::functions::avpIdAsPairString(a_id);
 419     msg += " with format '";
 420     msg += format;
 421     msg += "' is not compatible with the API method used (";
 422     msg += name;
 423     msg += ")";
 424     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 425   }
 426 }
 427
 428
 429 //------------------------------------------------------------------------------
 430 //--------------------------------------------------------------- Avp::flagsOK()
 431 //------------------------------------------------------------------------------
 432 bool Avp::flagsOK() const throw() {
 433   // Dictionary stack avp:
 434   const stack::Avp *stackAvp = getStackAvp();
 435
 436   if(!stackAvp) {
 437     anna::Logger::error("Impossible to decide if flags are correct because stack avp is not identified. Assume flags ok", ANNA_FILE_LOCATION);
 438     return true;
 439   };
 440
 441   // Assignments
 442   bool Vnone = (stackAvp->getVbit() == stack::Avp::FlagRule::None);
 443
 444   bool Vmust = (stackAvp->getVbit() == stack::Avp::FlagRule::must);
 445
 446   bool Vmustnot = (stackAvp->getVbit() == stack::Avp::FlagRule::mustnot);
 447
 448   bool Mnone = (stackAvp->getMbit() == stack::Avp::FlagRule::None);
 449
 450   bool Mmust = (stackAvp->getMbit() == stack::Avp::FlagRule::must);
 451
 452   bool Mmustnot = (stackAvp->getMbit() == stack::Avp::FlagRule::mustnot);
 453
 454   bool Pnone = (stackAvp->getPbit() == stack::Avp::FlagRule::None);
 455
 456   bool Pmust = (stackAvp->getPbit() == stack::Avp::FlagRule::must);
 457
 458   bool Pmustnot = (stackAvp->getPbit() == stack::Avp::FlagRule::mustnot);
 459
 460   // V-bit
 461   if((Vnone && Mnone && Pnone && vendorBit()) || (Vmust && !vendorBit()) || (Vmustnot && vendorBit())) {
 462     anna::Logger::error("Vendor Bit (V) incoherence found", ANNA_FILE_LOCATION);
 463     return false;
 464   }
 465
 466   // Exit on permissive mode:
 467   if(getEngine()->ignoreFlagsOnValidation()) return true;  // Ignore checking for AVP 'M' & 'P' bits
 468
 469   // M-bit
 470   if((Mmust && !mandatoryBit()) || (Mmustnot && mandatoryBit())) {
 471     anna::Logger::error("Mandatory Bit (M) incoherence found", ANNA_FILE_LOCATION);
 472     return false;
 473   }
 474
 475   // P-bit
 476   if((Pmust && !encryptionBit()) || (Pmustnot && encryptionBit())) {
 477     anna::Logger::error("Encryption Bit (P) incoherence found", ANNA_FILE_LOCATION);
 478     return false;
 479   }
 480
 481   // Reserved bits
 482   if((a_flags & 0x1f) != 0x00) {
 483     anna::Logger::error("Any (or more than one) of the reserved avp flags bit has been activated. Reserved bits must be null", ANNA_FILE_LOCATION);
 484     return false;
 485   }
 486
 487   return true;
 488 }
 489
 490
 491 //------------------------------------------------------------------------------
 492 //----------------------------------------------------------------- Avp::setId()
 493 //------------------------------------------------------------------------------
 494 void Avp::setId(AvpId id) throw(anna::RuntimeException) {
 495   // Generic AVP assignment has no sense
 496   if(id == helpers::AVPID__AVP) return;
 497
 498   // Clear class content:
 499   clear();
 500   // Id assignment:
 501   a_id = id;
 502   // Dictionary stack avp and format:
 503   const stack::Avp *stackAvp = getStackAvp(); // based on dictionary and a_id
 504   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 505
 506   // Dictionary flags for known types:
 507   if(stackAvp) {
 508     if(stackAvp->getVbit() == stack::Avp::FlagRule::must) a_flags |= VBitMask;
 509
 510     if(stackAvp->getMbit() == stack::Avp::FlagRule::must) a_flags |= MBitMask;
 511
 512     if(stackAvp->getPbit() == stack::Avp::FlagRule::must) a_flags |= PBitMask;
 513   } else {
 514     if(a_id.second != 0) a_flags |= VBitMask; else a_flags &= (~VBitMask);
 515   }
 516
 517   if(!stackFormat) {  // Unknown Avp
 518     LOGDEBUG(
 519       std::string msg = "Unknown format for AVP identifier ";
 520       msg += anna::diameter::functions::avpIdAsPairString(id);
 521       msg += ". Raw data without specific format will be managed";
 522       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 523     );
 524     a_Unknown = new Unknown();
 525     return;
 526   }
 527
 528   // Avp class formats (Avp child classes should implement this source code block for application-specific formats):
 529   if(stackFormat->isOctetString()) a_OctetString = new OctetString();
 530   else if(stackFormat->isInteger32()) a_Integer32 = new Integer32();
 531   else if(stackFormat->isInteger64()) a_Integer64 = new Integer64();
 532   else if(stackFormat->isUnsigned32()) a_Unsigned32 = new Unsigned32();
 533   else if(stackFormat->isUnsigned64()) a_Unsigned64 = new Unsigned64();
 534   else if(stackFormat->isFloat32()) a_Float32 = new Float32();
 535   else if(stackFormat->isFloat64()) a_Float64 = new Float64();
 536   //else if (stackFormat->isGrouped())
 537   else if(stackFormat->isAddress()) a_Address = new Address();
 538   else if(stackFormat->isTime()) a_Time = new Time();
 539   else if(stackFormat->isUTF8String()) a_UTF8String = new UTF8String();
 540   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity = new DiameterIdentity();
 541   else if(stackFormat->isDiameterURI()) a_DiameterURI = new DiameterURI();
 542   else if(stackFormat->isEnumerated()) a_Enumerated = new Enumerated();
 543   else if(stackFormat->isIPFilterRule()) a_IPFilterRule = new IPFilterRule();
 544   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule = new QoSFilterRule();
 545
 546   /////////////////////
 547   // Format specific //
 548   /////////////////////
 549   allocationByFormat(stackFormat);
 550 }
 551
 552
 553 //------------------------------------------------------------------------------
 554 //----------------------------------------------------------------- Avp::setId()
 555 //------------------------------------------------------------------------------
 556 void Avp::setId(const char *name) throw(anna::RuntimeException) {
 557   setId(getEngine()->avpIdForName(name));
 558 }
 559
 560
 561 //------------------------------------------------------------------------------
 562 //---------------------------------------------------------------- Avp::addAvp()
 563 //------------------------------------------------------------------------------
 564 Avp * Avp::addAvp(const char *name) throw(anna::RuntimeException) {
 565   return addAvp(getEngine()->avpIdForName(name));
 566 }
 567
 568
 569 //------------------------------------------------------------------------------
 570 //------------------------------------------------------------- Avp::removeAvp()
 571 //------------------------------------------------------------------------------
 572 bool Avp::removeAvp(const char *name, int ocurrence) throw(anna::RuntimeException) {
 573   return removeAvp(getEngine()->avpIdForName(name), ocurrence);
 574 }
 575
 576
 577 //------------------------------------------------------------------------------
 578 //--------------------------------------------------------------- Avp::_getAvp()
 579 //------------------------------------------------------------------------------
 580 const Avp *Avp::_getAvp(const char *name, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
 581   return getAvp(getEngine()->avpIdForName(name), ocurrence, emode);
 582 }
 583
 584
 585 //------------------------------------------------------------------------------
 586 //-------------------------------------------------------------- Avp::countAvp()
 587 //------------------------------------------------------------------------------
 588 int Avp::countAvp(const char *name) const throw(anna::RuntimeException) {
 589   return countAvp(getEngine()->avpIdForName(name));
 590 }
 591
 592 //------------------------------------------------------------------------------
 593 //------------------------------------------------------------- Avp::getLength()
 594 //------------------------------------------------------------------------------
 595 U24 Avp::getLength() const throw() {
 596   U24 result;
 597   // Avp format:
 598   const stack::Avp *stackAvp = getStackAvp();
 599   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 600   // Header length:
 601   result = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
 602
 603   if(!stackFormat) {
 604     result += a_Unknown->getSize();
 605     return result;
 606   }
 607
 608   if(stackFormat->isOctetString()) result += a_OctetString->getSize();
 609   else if(stackFormat->isInteger32()) result += a_Integer32->getSize();
 610   else if(stackFormat->isInteger64()) result += a_Integer64->getSize();
 611   else if(stackFormat->isUnsigned32()) result += a_Unsigned32->getSize();
 612   else if(stackFormat->isUnsigned64()) result += a_Unsigned64->getSize();
 613   else if(stackFormat->isFloat32()) result += a_Float32->getSize();
 614   else if(stackFormat->isFloat64()) result += a_Float64->getSize();
 615   else if(stackFormat->isGrouped()) for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) result += 4 * REQUIRED_WORDS(avp(it)->getLength());
 616   else if(stackFormat->isAddress()) result += a_Address->getSize();
 617   else if(stackFormat->isTime()) result += a_Time->getSize();
 618   else if(stackFormat->isUTF8String()) result += a_UTF8String->getSize();
 619   else if(stackFormat->isDiameterIdentity()) result += a_DiameterIdentity->getSize();
 620   else if(stackFormat->isDiameterURI()) result += a_DiameterURI->getSize();
 621   else if(stackFormat->isEnumerated()) result += a_Enumerated->getSize();
 622   else if(stackFormat->isIPFilterRule()) result += a_IPFilterRule->getSize();
 623   else if(stackFormat->isQoSFilterRule()) result += a_QoSFilterRule->getSize();
 624
 625   /////////////////////
 626   // Format specific //
 627   /////////////////////
 628   result += getLengthByFormat(stackFormat);
 629   return result;
 630 }
 631
 632
 633 //------------------------------------------------------------------------------
 634 //-------------------------------------------- Avp::unknownAvpWithMandatoryBit()
 635 //------------------------------------------------------------------------------
 636 void Avp::unknownAvpWithMandatoryBit() const throw(anna::RuntimeException) {
 637   OamModule &oamModule = OamModule::instantiate();
 638   const char *c_aid = STRING_WITH_QUOTATION_MARKS__C_STR(anna::diameter::functions::avpIdAsPairString(a_id));
 639   oamModule.activateAlarm(OamModule::Alarm::AvpDecode__UnknownAvp__s__WithMandatoryBit, c_aid);
 640   oamModule.count(OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit);
 641   LOGWARNING(
 642     std::string msg = anna::functions::asString("Detected unknown Avp %s with mandatory bit activated", c_aid);
 643     anna::Logger::warning(msg, ANNA_FILE_LOCATION);
 644   );
 645 }
 646
 647 //------------------------------------------------------------------------------
 648 //-------------------------------------------------------- Avp::decodeDataPart()
 649 //------------------------------------------------------------------------------
 650 void Avp::decodeDataPart(const char * buffer, int size, const parent_t & parent, Message *answer) throw(anna::RuntimeException) {
 651   // OAM
 652   OamModule &oamModule = OamModule::instantiate();
 653   // Dictionary stack avp and format:
 654   const stack::Avp *stackAvp = getStackAvp();
 655   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 656
 657   if(!stackFormat) {
 658     a_Unknown->decode(buffer, size);
 659     return;
 660   }
 661
 662   if(stackFormat->isOctetString()) a_OctetString->decode(buffer, size);
 663   else if(stackFormat->isInteger32()) a_Integer32->decode(buffer, size);
 664   else if(stackFormat->isInteger64()) a_Integer64->decode(buffer, size);
 665   else if(stackFormat->isUnsigned32()) a_Unsigned32->decode(buffer, size);
 666   else if(stackFormat->isUnsigned64()) a_Unsigned64->decode(buffer, size);
 667   else if(stackFormat->isFloat32()) a_Float32->decode(buffer, size);
 668   else if(stackFormat->isFloat64()) a_Float64->decode(buffer, size);
 669   else if(stackFormat->isGrouped()) {
 670     if(size == 0) {
 671       LOGDEBUG(anna::Logger::debug("Grouped Avp has empty data part", ANNA_FILE_LOCATION));
 672       return;
 673     }
 674
 675     if((size % 4) != 0) {
 676       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
 677       oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
 678
 679       if(answer) {
 680         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_LENGTH);
 681         answer->setFailedAvp(parent, a_id);
 682       }
 683
 684       throw anna::RuntimeException("Avp format error, the avp length is incorrect (must be multiple of 4 on grouped type)", ANNA_FILE_LOCATION);
 685     }
 686
 687     int avpPos = 0;
 688     Avp* avp;
 689     anna::DataBlock db;
 690     // Me as parent:
 691     parent_t me = parent;
 692     me.addAvp(a_id);
 693
 694     while(avpPos < size) {
 695       try {
 696         avp = getEngine()->allocateAvp();
 697         db.assign(buffer + avpPos, size - avpPos /* is valid to pass total size (indeed i don't know the real avp size) because it will be limited and this has deep copy disabled (no memory is reserved) */);
 698         avp -> decode(db, me, answer);
 699       } catch(anna::RuntimeException &ex) {
 700         getEngine()->releaseAvp(avp);
 701         throw;
 702       }
 703
 704       addChild(avp);
 705       avpPos += 4 * REQUIRED_WORDS(avp->getLength());
 706     }
 707   } else if(stackFormat->isAddress()) a_Address->decode(buffer, size);
 708   else if(stackFormat->isTime()) a_Time->decode(buffer, size);
 709   else if(stackFormat->isUTF8String()) a_UTF8String->decode(buffer, size);
 710   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->decode(buffer, size);
 711   else if(stackFormat->isDiameterURI()) a_DiameterURI->decode(buffer, size);
 712   else if(stackFormat->isEnumerated()) a_Enumerated->decode(buffer, size);
 713   else if(stackFormat->isIPFilterRule()) a_IPFilterRule->decode(buffer, size);
 714   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->decode(buffer, size);
 715
 716   /////////////////////
 717   // Format specific //
 718   /////////////////////
 719   decodeDataPartByFormat(buffer, size, stackFormat);
 720 }
 721
 722 //------------------------------------------------------------------------------
 723 //---------------------------------------------------------------- Avp::decode()
 724 //------------------------------------------------------------------------------
 725 void Avp::decode(const anna::DataBlock &db, const parent_t & parent, Message *answer) throw(anna::RuntimeException) {
 726   // OAM
 727   OamModule &oamModule = OamModule::instantiate();
 728
 729   if(db.getSize() < HeaderLengthVinactive) {
 730     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 731     oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 732     // DIAMETER_INVALID_AVP_LENGTH; // no podr� construir un avp fiable, as� que no registro el result-code
 733     throw anna::RuntimeException("Not enough bytes to cover avp header length", ANNA_FILE_LOCATION);
 734   }
 735
 736   const char * buffer = db.getData();
 737
 738   //       0                   1                   2                   3
 739   //       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 740   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 741   //      |                           AVP Code                            |
 742   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 743   //      |   AVP Flags   |                  AVP Length                   |
 744   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 745   //      |                        Vendor-ID (opt)                        |
 746   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 747   //      |    Data ...
 748   //      +-+-+-+-+-+-+-+-+
 749   // Code flags and vendor-id
 750   U32 code = DECODE4BYTES_INDX_VALUETYPE(buffer, 0, U32);
 751
 752   a_flags = (S8)buffer[4];
 753
 754   U32 vendorID = helpers::VENDORID__base;
 755
 756   if(vendorBit()) {
 757     if(db.getSize() < HeaderLengthVactive) {
 758       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 759       oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
 760       // DIAMETER_INVALID_AVP_LENGTH; // no podr� construir un avp fiable, as� que no registro el result-code
 761       throw anna::RuntimeException(anna::functions::asString("Not enough bytes to cover avp header length (avp code = %u)", code), ANNA_FILE_LOCATION);
 762     }
 763
 764     vendorID = DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32);
 765
 766     if(vendorID == helpers::VENDORID__base) {
 767       //      A vendor ID value of zero (0) corresponds to the IETF adopted AVP
 768       //      values, as managed by the IANA. Since the absence of the vendor
 769       //      ID field implies that the AVP in question is not vendor specific,
 770       //      ...
 771       //      implementations MUST NOT use the zero (0) vendor ID.
 772       oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
 773       oamModule.count(OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
 774       throw anna::RuntimeException(anna::functions::asString("Incoherence between activated V bit and zeroed vendor-id value received (avp code = %u)", code), ANNA_FILE_LOCATION);
 775     }
 776   }
 777
 778   // Avp identifier
 779   setId(AvpId(code, vendorID));
 780   // Flags could have been updated regarding dictionary, but during decoding we must respect buffer received:
 781   a_flags = (S8)buffer[4];
 782
 783   // Here i know id and flags:
 784   //   The 'M' Bit, known as the Mandatory bit, indicates whether support of the AVP is required. If an AVP with the 'M' bit set is received by
 785   //   a Diameter client, server, proxy, or translation agent and either the AVP or its value is unrecognized, the message MUST be rejected.
 786   //   Diameter Relay and redirect agents MUST NOT reject messages with unrecognized AVPs.
 787   if(!getStackAvp() && mandatoryBit()) {
 788     if(answer) {
 789       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_UNSUPPORTED);
 790       answer->setFailedAvp(parent, a_id);
 791     }
 792
 793     unknownAvpWithMandatoryBit();
 794   }
 795
 796   // Avp Length
 797   U24 length = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
 798   // Data start position:
 799   int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
 800   // Data part:
 801   int dataBytes = length - startDataPos;
 802
 803   if(dataBytes < 0) {
 804     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
 805     oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
 806
 807     if(answer) {
 808       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_LENGTH);
 809       answer->setFailedAvp(parent, a_id);
 810     }
 811
 812     throw anna::RuntimeException(anna::functions::asString("Avp format error, the avp length is incorrect (avp code = %u)", code), ANNA_FILE_LOCATION);
 813   }
 814
 815   try {
 816     decodeDataPart(buffer + startDataPos, dataBytes, parent, answer);
 817   } catch(anna::RuntimeException &ex) {
 818     oamModule.activateAlarm(OamModule::Alarm::AvpDecode__DataPartInconsistence);
 819     oamModule.count(OamModule::Counter::AvpDecode__DataPartInconsistence);
 820
 821     if(answer) {
 822       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE);
 823       answer->setFailedAvp(parent, a_id);
 824     }
 825
 826     throw anna::RuntimeException(anna::functions::asString("Internal Avp decoding error (avp code = %u): %s", code, ex.getText().c_str()), ANNA_FILE_LOCATION);
 827   }
 828 }
 829
 830
 831 //------------------------------------------------------------------------------
 832 //----------------------------------------------------------- Avp::getStackAvp()
 833 //------------------------------------------------------------------------------
 834 const anna::diameter::stack::Avp *Avp::getStackAvp(AvpId id, Engine *engine) throw() {
 835   const stack::Dictionary * dictionary = engine->getDictionary();
 836   return (dictionary ? (dictionary->getAvp(id)) : NULL);
 837 }
 838
 839
 840 //------------------------------------------------------------------------------
 841 //------------------------------------------------------------------- Avp::fix()
 842 //------------------------------------------------------------------------------
 843 void Avp::fix(avp_container &avps, find_container &finds, int &insertionPositionForChilds, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd) throw() {
 844   // Exit cases
 845   if(avps.size() == 0) return;  // empty content, nothing to fix
 846
 847   if(ruleBegin == ruleEnd) return;  // no reference. Cannot fix
 848
 849   // Copy reference container and clear internal map in order to build a fixed version:
 850   avp_container unfixedAvps;
 851
 852   for(const_avp_iterator it = avps.begin(); it != avps.end(); it++)
 853     unfixedAvps[(*it).first] = (*it).second;
 854
 855   avps.clear();
 856   // Cache system reset (fix probably will invalidate cached findings):
 857   finds.clear();
 858   insertionPositionForChilds = 0;
 859   avp_iterator avp_it;
 860   Avp * avp;
 861
 862   for(anna::diameter::stack::const_avprule_iterator rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 863     while((avp_it = Avp::avp_find(unfixedAvps, (*rule_it).second.getId(), 1)) != unfixedAvps.end()) {
 864       avp = (*avp_it).second;
 865       addChild(avps, insertionPositionForChilds, avp);
 866       unfixedAvps.erase(avp_it); // processed
 867     }
 868   }
 869
 870   // Add remaining avps:
 871   for(avp_it = unfixedAvps.begin(); avp_it != unfixedAvps.end(); avp_it++) {
 872     avp = (*avp_it).second;
 873
 874     if(avp) addChild(avps, insertionPositionForChilds, avp);
 875   }
 876
 877   // Fix grouped Avps:
 878   for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
 879     avp = (*it).second;
 880
 881     if(avp->hasChildren()) avp->fix();
 882   }
 883 }
 884
 885
 886 //------------------------------------------------------------------------------
 887 //------------------------------------------------------------------- Avp::fix()
 888 //------------------------------------------------------------------------------
 889 void Avp::fix() throw() {
 890   // Dictionary stack avp:
 891   const stack::Avp *stackAvp = getStackAvp();
 892   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
 893
 894   if(!stackAvp) {
 895     //LOGDEBUG(anna::Logger::debug("No dictionary avp reference found. Cannot fix.", ANNA_FILE_LOCATION));
 896     return;
 897   }
 898
 899   if(!stackFormat || !stackFormat->isGrouped()) {
 900     //LOGDEBUG(anna::Logger::debug("Avp is not grouped. Nothing to fix.", ANNA_FILE_LOCATION));
 901     return;
 902   }
 903
 904   fix(a_avps, (find_container&)a_finds, a_insertionPositionForChilds, stackAvp->avprule_begin(), stackAvp->avprule_end());
 905 }
 906
 907
 908 //------------------------------------------------------------------------------
 909 //------------------------------------------------------------ Avp::validLevel()
 910 //------------------------------------------------------------------------------
 911 bool Avp::validLevel(const avp_container &avps, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd, Engine * engine, const parent_t & parent, Message *answer) throw(anna::RuntimeException) {
 912   bool result = true;
 913   // OAM
 914   OamModule &oamModule = OamModule::instantiate();
 915   ///////////
 916   // Fixed //
 917   ///////////
 918   // auxiliary
 919   AvpId id;
 920   const_avp_iterator avp_it = avps.begin();
 921   anna::diameter::stack::const_avprule_iterator rule_it;
 922   bool okFixed;
 923
 924   for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 925     okFixed = true;
 926
 927     if((*rule_it).second.isFixed()) {
 928       if(avps.size() == 0) break;  // cardinality checking will show this anomaly
 929
 930       if(avp_it != avps.end()) {
 931         id = Avp::avp(avp_it)->getId();
 932
 933         if(id != (*rule_it).second.getId()) {
 934           okFixed = false;
 935           // Missing fixed rule: %s
 936         } else if(Avp::avp_find(avps, id, 2) != avps.end()) {
 937           okFixed = false;
 938           // More than one fixed ocurrency for rule %s (*)
 939         }
 940
 941         avp_it++;
 942         // (*) for (int k = 0; k < (*rule_it).second.getQualMax(); k++) avp_it++
 943       } else
 944         okFixed = false;
 945
 946       if(!okFixed) {
 947         result = false;
 948         // OAM & Depth management
 949         oamModule.activateAlarm(OamModule::Alarm::LevelValidation__MissingFixedRule__s__Inside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString()));
 950         oamModule.count(OamModule::Counter::LevelValidation__MissingFixedRule);
 951
 952         if(answer) {
 953           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
 954           answer->setFailedAvp(parent, (*rule_it).second.getId());
 955         }
 956
 957         engine->validationAnomaly(anna::functions::asString("Missing fixed rule %s inside %s", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString())));
 958       }
 959     } else break; // finish fixed
 960   }
 961
 962   /////////////////
 963   // Cardinality // Mandatory control is implicit here
 964   /////////////////
 965   anna::diameter::stack::const_avprule_iterator generic_rule_it = ruleEnd;
 966   int min, max, amount;
 967
 968   for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
 969     if((*rule_it).second.isAny()) { generic_rule_it = rule_it; continue; }  // generic Avp will be managed after
 970
 971     id = (*rule_it).second.getId();
 972     min = (*rule_it).second.getQualMin();
 973     max = (*rule_it).second.getQualMax(); // -1 means infinite
 974     amount = Avp::countAvp(avps, id);
 975
 976     if((amount < min) || ((max != -1) && (amount > max))) {
 977       // Failed rule %s for cardinality (found %d items)
 978       result = false;
 979       // OAM & Depth management
 980       oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedRule__s__ForCardinality_Found__d__ItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString()));
 981       oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinality);
 982
 983       if(amount < min) {
 984         oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded);
 985
 986         if(answer) {
 987           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
 988           answer->setFailedAvp(parent, id);
 989         }
 990       } else {
 991         oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded);
 992
 993         if(answer) {
 994           answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_OCCURS_TOO_MANY_TIMES);
 995           answer->setFailedAvp(parent, id);
 996         }
 997       }
 998
 999       engine->validationAnomaly(anna::functions::asString("Failed rule %s for cardinality (found %d items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString())));
1000     }
1001   }
1002
1003   bool haveGeneric = (generic_rule_it != ruleEnd);
1004   /////////////////
1005   // Generic AVP //
1006   /////////////////
1007   bool foundInRules;
1008   std::map < AvpId, int /* dummy */ > disregarded; // 'Disregardeds' are Avps not in rules list
1009   std::map < AvpId, int /* dummy */ >::const_iterator disregarded_it;
1010
1011   for(avp_it = avps.begin(); avp_it != avps.end(); avp_it++) {
1012     id = Avp::avp(avp_it)->getId();
1013     // Find rule for the child:
1014     foundInRules = false;
1015
1016     for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
1017       if((*rule_it).second.getId() == id) {
1018         foundInRules = true;
1019         break;
1020       }
1021     }
1022
1023     if(!foundInRules) {
1024       disregarded[id] = 0;
1025     }
1026   }
1027
1028   // Generic AVP cardinality checkings
1029   int disregardeds = disregarded.size();
1030
1031   if(haveGeneric) {
1032     min = (*generic_rule_it).second.getQualMin();
1033     max = (*generic_rule_it).second.getQualMax(); // -1 means infinite
1034     amount = disregardeds;
1035
1036     if((amount < min) || ((max != -1) && (amount > max))) {
1037       // Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)
1038       result = false;
1039       // OAM & Depth management
1040       oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedGenericAvpRule__s__ForCardinality_Found__d__DisregardedItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString()));
1041       oamModule.count(OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem);
1042
1043       if(answer) {
1044         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1045         answer->setFailedAvp(parent, id); // NO SENSE... what to put ?
1046       }
1047
1048       engine->validationAnomaly(anna::functions::asString("Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString())));
1049     }
1050   } else if(disregardeds) {  // When Generic AVP missing, no disregarded Avps are allowed
1051     // Found %d disregarded items inside %s and Generic AVP was not specified
1052     result = false;
1053     // Build disregarded list as string (unknown as avp id pair):
1054     std::string s_disregardeds = "";
1055     const stack::Avp *stackAvp;
1056
1057     for(disregarded_it = disregarded.begin(); disregarded_it != disregarded.end(); disregarded_it++) {
1058       id = (*disregarded_it).first;
1059       stackAvp = getStackAvp(id, engine);
1060       s_disregardeds += (stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id)));
1061       s_disregardeds += ", ";
1062
1063       // We wouldn't know where are these disregarded, but...
1064       if(answer) {
1065         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1066         answer->setFailedAvp(parent, id);
1067       }
1068     }
1069
1070     s_disregardeds.erase(s_disregardeds.size() - 2, 2); // remove last ', '
1071     // OAM & Depth management
1072     oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FoundDisregardedItemsInside__s__AndGenericAVPWasNotSpecified__s__, STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString()), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds));
1073     oamModule.count(OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified);
1074     engine->validationAnomaly(anna::functions::asString("Found disregarded items inside %s and Generic AVP was not specified: %s", STRING_WITH_QUOTATION_MARKS__C_STR(parent.asString()), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds)));
1075   }
1076
1077   return result;
1078 }
1079
1080
1081 //------------------------------------------------------------------------------
1082 //----------------------------------------------------------------- Avp::valid()
1083 //------------------------------------------------------------------------------
1084 bool Avp::valid(const parent_t & parent, Message *answer) const throw(anna::RuntimeException) {
1085   // OAM
1086   OamModule &oamModule = OamModule::instantiate();
1087   // Dictionary stack avp:
1088   const stack::Avp *stackAvp = getStackAvp();
1089   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1090
1091   if(!stackAvp) {
1092     // No dictionary avp reference found. Cannot validate
1093     return true; // perhaps a unknown Avp
1094   }
1095
1096   // Me as parent:
1097   parent_t me = parent;
1098   me.addAvp(a_id, stackAvp->getName().c_str());
1099
1100   if(!stackFormat) {
1101     // No format avp reference found. Cannot validate
1102     return true; // perhaps a unknown Avp
1103   }
1104
1105   //////////////////////////////
1106   // Flags coherence checking //
1107   //////////////////////////////
1108   bool result = flagsOK();
1109
1110   if(!result) {
1111     // OAM & Depth management
1112     oamModule.activateAlarm(OamModule::Alarm::AvpValidation__Avp__s__Flags__d__DoesNotFulfillTheDefinedFlagRules__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription()));
1113     oamModule.count(OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules);
1114
1115     if(answer) {
1116       answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_BITS);
1117       answer->setFailedAvp(parent, a_id, stackAvp->getName().c_str()); // RFC 6733 says nothing about Failed-AVP in this case...
1118     }
1119
1120     getEngine()->validationAnomaly(anna::functions::asString("The AVP %s flags (%d) does not fulfill the defined flag rules: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription())));
1121   }
1122
1123   //////////////////////
1124   // Enumerated range //
1125   //////////////////////
1126   if(stackFormat->isEnumerated()) {
1127     if(!stackAvp->allowEnum(a_Enumerated->getValue())) {
1128       result = false;
1129       // OAM & Depth management
1130       oamModule.activateAlarm(OamModule::Alarm::AvpValidation__EnumeratedAvp__s__WithValue__d__DoesNotComplyRestriction__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), a_Enumerated->getValue(), stackAvp->getEnums());
1131       oamModule.count(OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction);
1132
1133       if(answer) {
1134         answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE);
1135         answer->setFailedAvp(parent, a_id, stackAvp->getName().c_str());
1136       }
1137
1138       getEngine()->validationAnomaly(anna::functions::asString("Enumerated AVP %s with value %d does not comply to restriction: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), a_Enumerated->getValue(), stackAvp->getEnums()));
1139     }
1140   }
1141
1142   ////////////////////
1143   // Level checking //
1144   ////////////////////
1145   result = Avp::validLevel(a_avps, stackAvp->avprule_begin(), stackAvp->avprule_end(), getEngine(), me, answer) && result;
1146
1147   ////////////////////////
1148   // Childrens checking //
1149   ////////////////////////
1150   if(a_id == helpers::base::AVPID__Failed_AVP) return result;  // DON'T VALIDATE CONTENT FOR Failed-AVP, because it won't be valid...
1151
1152   for(const_avp_iterator it = avp_begin(); it != avp_end(); it++)
1153     result = ((*it).second->valid(me, answer)) && result;
1154
1155   return result;
1156 }
1157
1158
1159 //------------------------------------------------------------------------------
1160 //------------------------------------------------------------------ Avp::code()
1161 //------------------------------------------------------------------------------
1162 void Avp::code(char* buffer, int &size) const throw(anna::RuntimeException) {
1163   // Code
1164   buffer[0] = (S8)(a_id.first >> 24);
1165   buffer[1] = (S8)(a_id.first >> 16);
1166   buffer[2] = (S8)(a_id.first >> 8);
1167   buffer[3] = (S8) a_id.first;
1168   // Flags and length
1169   size = getLength();
1170   buffer[4] = (S8) a_flags;
1171   buffer[5] = (S8)(size >> 16);
1172   buffer[6] = (S8)(size >> 8);
1173   buffer[7] = (S8) size;
1174
1175   // Vendor-id
1176   if(vendorBit()) {
1177     buffer[8] = (S8)(a_id.second >> 24);
1178     buffer[9] = (S8)(a_id.second >> 16);
1179     buffer[10] = (S8)(a_id.second >> 8);
1180     buffer[11] = (S8) a_id.second;
1181   }
1182
1183   // Data start position:
1184   int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
1185   // Data part:
1186   S8 * dataPart = buffer + startDataPos;
1187   int dataBytes; // not used but could be useful for checking (size - startDataPos)
1188
1189   if(startDataPos == size) {
1190     LOGDEBUG(anna::Logger::debug("There is no data part to encode", ANNA_FILE_LOCATION));
1191     return;
1192   }
1193
1194   // Avp format:
1195   const stack::Avp *stackAvp = getStackAvp();
1196   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1197
1198   if(!stackFormat) {
1199     a_Unknown->code(dataPart, dataBytes);
1200     return;
1201   }
1202
1203   if(stackFormat->isOctetString()) a_OctetString->code(dataPart, dataBytes);
1204   else if(stackFormat->isInteger32()) a_Integer32->code(dataPart, dataBytes);
1205   else if(stackFormat->isInteger64()) a_Integer64->code(dataPart, dataBytes);
1206   else if(stackFormat->isUnsigned32()) a_Unsigned32->code(dataPart, dataBytes);
1207   else if(stackFormat->isUnsigned64()) a_Unsigned64->code(dataPart, dataBytes);
1208   else if(stackFormat->isFloat32()) a_Float32->code(dataPart, dataBytes);
1209   else if(stackFormat->isFloat64()) a_Float64->code(dataPart, dataBytes);
1210   else if(stackFormat->isGrouped()) {
1211 //      // Each avp encoding will remain padding octets depending on format. In order to
1212 //      //  code grouped content (each avp will be multiple of 4) we clean the entire buffer
1213 //      //  to ensure padding (easier than custom-made for each format):
1214 //      memset(dataPart, 0, size - startDataPos);
1215     char *dataPartGrouped = dataPart;
1216     int dataBytesGrouped;
1217
1218     for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
1219       avp(it)->code(dataPartGrouped, dataBytesGrouped);
1220       dataPartGrouped = dataPartGrouped + 4 * REQUIRED_WORDS(dataBytesGrouped);
1221     }
1222   } else if(stackFormat->isAddress()) a_Address->code(dataPart, dataBytes);
1223   else if(stackFormat->isTime()) a_Time->code(dataPart, dataBytes);
1224   else if(stackFormat->isUTF8String()) a_UTF8String->code(dataPart, dataBytes);
1225   else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->code(dataPart, dataBytes);
1226   else if(stackFormat->isDiameterURI()) a_DiameterURI->code(dataPart, dataBytes);
1227   else if(stackFormat->isEnumerated()) a_Enumerated->code(dataPart, dataBytes);
1228   else if(stackFormat->isIPFilterRule()) a_IPFilterRule->code(dataPart, dataBytes);
1229   else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->code(dataPart, dataBytes);
1230
1231   /////////////////////
1232   // Format specific //
1233   /////////////////////
1234   codeByFormat(dataPart, stackFormat);
1235 }
1236
1237
1238 //------------------------------------------------------------------------------
1239 //------------------------------------------------------------ Avp::getXMLdata()
1240 //------------------------------------------------------------------------------
1241 std::string Avp::getXMLdata(bool & isHex, const stack::Format *stackFormat) const throw() {
1242   std::string result = "";
1243   isHex = false;
1244   // Unknown
1245 //   try {
1246 //      if (!stackFormat) {
1247 //         isHex = true;
1248 //         return a_Unknown->asHexString();
1249 //      }
1250 //   } catch (anna::RuntimeException &ex) {
1251 //      ex.trace();
1252 //   }
1253
1254   if(!stackFormat) {
1255     isHex = true;
1256     return a_Unknown->asHexString(); // el asHexString del OctetString no puede lanzar una excepcion en realidad
1257   }
1258
1259   // Special case for Address: could launch exception if not printable
1260   try {
1261     if(stackFormat->isAddress()) return a_Address->asPrintableString();
1262   } catch(anna::RuntimeException&) {
1263     //ex.trace();
1264     isHex = true;
1265     return a_Address->asHexString();
1266   }
1267
1268   try {
1269     if(stackFormat->isOctetString()) {
1270       isHex = true;
1271       return a_OctetString->asHexString();
1272     }
1273
1274     // Non-hexadecimal
1275     if(stackFormat->isInteger32()) return a_Integer32->asPrintableString();
1276
1277     if(stackFormat->isInteger64()) return a_Integer64->asPrintableString();
1278
1279     if(stackFormat->isUnsigned32()) return a_Unsigned32->asPrintableString();
1280
1281     if(stackFormat->isUnsigned64()) return a_Unsigned64->asPrintableString();
1282
1283     if(stackFormat->isFloat32()) return a_Float32->asPrintableString();
1284
1285     if(stackFormat->isFloat64()) return a_Float64->asPrintableString();
1286
1287     //if (stackFormat->isAddress()) return a_Address->asPrintableString();
1288
1289     if(stackFormat->isTime()) return a_Time->asPrintableString();
1290
1291     if(stackFormat->isUTF8String()) return a_UTF8String->asPrintableString();
1292
1293     if(stackFormat->isDiameterIdentity()) return a_DiameterIdentity->asPrintableString();
1294
1295     if(stackFormat->isDiameterURI()) return a_DiameterURI->asPrintableString();
1296
1297     if(stackFormat->isEnumerated()) return a_Enumerated->asPrintableString();
1298
1299     if(stackFormat->isIPFilterRule()) return a_IPFilterRule->asPrintableString();
1300
1301     if(stackFormat->isQoSFilterRule()) return a_QoSFilterRule->asPrintableString();
1302
1303     /////////////////////
1304     // Format specific //
1305     /////////////////////
1306     return getXMLdataByFormat(isHex, stackFormat);
1307   } catch(anna::RuntimeException &ex) {
1308     ex.trace();
1309   }
1310
1311   return result;
1312 }
1313
1314
1315 //------------------------------------------------------------------------------
1316 //---------------------------------------------------------------- Avp::decode()
1317 //------------------------------------------------------------------------------
1318 void Avp::decode(const anna::DataBlock &db) throw(anna::RuntimeException) {
1319   parent_t parent;
1320   parent.setMessage(CommandId(0, false), "No-Parent");
1321   decode(db, parent, NULL);
1322 }
1323
1324
1325 //------------------------------------------------------------------------------
1326 //--------------------------------------------------------------- Avp::fromXML()
1327 //------------------------------------------------------------------------------
1328 void Avp::fromXML(const anna::xml::Node* avpNode) throw(anna::RuntimeException) {
1329   // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1330   const anna::xml::Attribute *name, *code, *vendorCode, *flags, *data, *hexData;
1331   name = avpNode->getAttribute("name", false /* no exception */);
1332   code = avpNode->getAttribute("code", false /* no exception */);
1333   vendorCode = avpNode->getAttribute("vendor-code", false /* no exception */);
1334   flags = avpNode->getAttribute("flags", false /* no exception */);
1335   data = avpNode->getAttribute("data", false /* no exception */);
1336   hexData = avpNode->getAttribute("hex-data", false /* no exception */);
1337   // Dictionary
1338   const stack::Dictionary * dictionary = getEngine()->getDictionary();
1339   const stack::Avp *stackAvp = NULL;
1340   const stack::Format *stackFormat = NULL;
1341
1342   // Compact mode
1343   if(name) {
1344     if(!dictionary) {
1345       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1346       msg += "'>: no dictionary available. Load one or use <'code' + 'flags' + 'vendorCode'> instead of <'name'>";
1347       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1348     }
1349
1350     stackAvp = dictionary->getAvp(name->getValue());
1351
1352     if(!stackAvp) {
1353       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1354       msg += "'>: no avp found for this identifier at available dictionary";
1355       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1356     }
1357
1358     stackFormat = stackAvp->getFormat();
1359   }
1360
1361   // Check attributes exclusiveness
1362   if(name) {  // compact mode
1363     if(code || flags || vendorCode) {
1364       std::string msg = "Error processing avp <name '"; msg += name->getValue();
1365       msg += "'>: avp attributes <'code' + 'flags' + 'vendorCode'> are not allowed if <'name'> is provided";
1366       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1367     }
1368
1369     setId(stackAvp->getId());
1370   } else {
1371     if(!code || !flags || !vendorCode) {
1372       std::string s_code = code ? code->getValue() : "?";
1373       std::string s_flags = flags ? flags->getValue() : "?";
1374       std::string s_vendorCode = vendorCode ? vendorCode->getValue() : "?";
1375       std::string msg = "Error processing avp <code '"; msg += s_code;
1376       msg += "' + flags '"; msg += s_flags;
1377       msg += "' + vendorCode '"; msg += s_vendorCode;
1378       msg += "'>: all must be provided if <'name'> don't";
1379       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1380     }
1381
1382     // Code check
1383     int i_aux = code->getIntegerValue();
1384
1385     if(i_aux < 0) {
1386       std::string msg = "Error processing avp <code '"; msg += code->getValue();
1387       msg += "': negative values are not allowed";
1388       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1389     }
1390
1391     U24 u_code = i_aux;
1392     // Flags check
1393     i_aux = flags->getIntegerValue();
1394
1395     if(i_aux < 0 || i_aux > 256) {
1396       std::string msg = "Error processing avp <flags '"; msg += flags->getValue();
1397       msg += "': out of range [0,256]";
1398       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1399     }
1400
1401     a_flags = i_aux;
1402     int flagsBCK = a_flags;
1403     // VendorCode checks
1404     i_aux = vendorCode->getIntegerValue();
1405
1406     if(i_aux < 0) {
1407       std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1408       msg += "': negative values are not allowed";
1409       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1410     }
1411
1412     U32 u_vendorCode = i_aux;
1413     bool vendorSpecific1 = (u_vendorCode != 0);
1414     bool vendorSpecific2 = (((a_flags) & VBitMask) != 0x00);
1415
1416     if(vendorSpecific1 != vendorSpecific2) {
1417       std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1418       msg += "' and avp <flags '"; msg += flags->getValue();
1419       msg += "': incompatible vendor-specific properties";
1420       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1421     }
1422
1423     // Final assignments
1424     setId(AvpId(u_code, u_vendorCode));
1425     // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
1426     a_flags = flagsBCK;
1427     stackAvp = getStackAvp();
1428     stackFormat = stackAvp ? stackAvp->getFormat() : NULL;
1429   }
1430
1431   // Childrens
1432   // Check if grouped not confirmed
1433   anna::xml::Node::const_child_iterator it;
1434   anna::xml::Node::const_child_iterator minii = avpNode->child_begin();
1435   anna::xml::Node::const_child_iterator maxii = avpNode->child_end();
1436   const bool hasChildren(minii != maxii);
1437
1438   if(hasChildren) {
1439     // We need to confirm is grouped
1440     if(!stackFormat)
1441       throw anna::RuntimeException("An xml avp node with children nodes could not confirmed as Grouped", ANNA_FILE_LOCATION);
1442
1443     if(!stackFormat->isGrouped())
1444       throw anna::RuntimeException("An xml avp node with children nodes is not grouped type", ANNA_FILE_LOCATION);
1445
1446     if(data || hexData)
1447       throw anna::RuntimeException("An xml avp node with children nodes has 'data' or 'hex-data' field", ANNA_FILE_LOCATION);
1448   }
1449
1450   // Presentation
1451   std::string s_avp = name ? (name->getValue()) : (anna::diameter::functions::avpIdAsPairString(a_id));
1452
1453   if(data && hexData) {
1454     std::string msg = "Not allowed both 'data' and 'hex-data' definitions. Avp ";
1455     msg += s_avp;
1456     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1457   }
1458
1459   LOGWARNING(
1460     bool unknown = !stackFormat;
1461     bool octetString = stackFormat && (stackFormat->isOctetString());
1462
1463   if(data && (unknown || octetString)) {
1464   std::string msg = "Not recommended 'data' field at ";
1465   msg += unknown ? "Unknown" : "OctetString";
1466   msg += "-format Avp "; msg += s_avp;
1467   msg += ". Use better 'hex-data' or omit content fields if empty";
1468   anna::Logger::warning(msg, ANNA_FILE_LOCATION);
1469   }
1470   );
1471
1472   if(!stackFormat) {
1473     if(data) a_Unknown->fromPrintableString(data->getValue().c_str());
1474     else if(hexData) a_Unknown->fromHexString(hexData->getValue());
1475
1476     return;
1477   }
1478
1479   if(stackFormat->isOctetString()) {
1480     if(data) a_OctetString->fromPrintableString(data->getValue().c_str());
1481     else if(hexData) a_OctetString->fromHexString(hexData->getValue());
1482   } else if(stackFormat->isInteger32()) {
1483     if(data) a_Integer32->fromPrintableString(data->getValue().c_str());
1484     else if(hexData) a_Integer32->fromHexString(hexData->getValue());
1485   } else if(stackFormat->isInteger64()) {
1486     if(data) a_Integer64->fromPrintableString(data->getValue().c_str());
1487     else if(hexData) a_Integer64->fromHexString(hexData->getValue());
1488   } else if(stackFormat->isUnsigned32()) {
1489     if(data) a_Unsigned32->fromPrintableString(data->getValue().c_str());
1490     else if(hexData) a_Unsigned32->fromHexString(hexData->getValue());
1491   } else if(stackFormat->isUnsigned64()) {
1492     if(data) a_Unsigned64->fromPrintableString(data->getValue().c_str());
1493     else if(hexData) a_Unsigned64->fromHexString(hexData->getValue());
1494   } else if(stackFormat->isFloat32()) {
1495     if(data) a_Float32->fromPrintableString(data->getValue().c_str());
1496     else if(hexData) a_Float32->fromHexString(hexData->getValue());
1497   } else if(stackFormat->isFloat64()) {
1498     if(data) a_Float64->fromPrintableString(data->getValue().c_str());
1499     else if(hexData) a_Float64->fromHexString(hexData->getValue());
1500   } else if(stackFormat->isGrouped()) {
1501     // Childrens
1502     Avp *avp;
1503
1504     for(it = minii; it != maxii; it++) {
1505       std::string nodeName = (*it)->getName();
1506
1507       if(nodeName != "avp") {
1508         std::string msg = "Unsupported grouped avp child node name '"; msg += nodeName;
1509         msg += "': use 'avp'";
1510         throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1511       }
1512
1513       try {
1514         avp =  getEngine()->allocateAvp();
1515         avp -> fromXML(*it);
1516       } catch(anna::RuntimeException &ex) {
1517         getEngine()->releaseAvp(avp);
1518         throw;
1519       }
1520
1521       addAvp(avp);
1522     }
1523   } else if(stackFormat->isAddress()) {
1524     if(data) a_Address->fromPrintableString(data->getValue().c_str());
1525     else if(hexData) a_Address->fromHexString(hexData->getValue());
1526   } else if(stackFormat->isTime()) {
1527     if(data) a_Time->fromPrintableString(data->getValue().c_str());
1528     else if(hexData) a_Time->fromHexString(hexData->getValue());
1529   } else if(stackFormat->isUTF8String()) {
1530     if(data) a_UTF8String->fromPrintableString(data->getValue().c_str());
1531     else if(hexData) a_UTF8String->fromHexString(hexData->getValue());
1532   } else if(stackFormat->isDiameterIdentity()) {
1533     if(data) a_DiameterIdentity->fromPrintableString(data->getValue().c_str());
1534     else if(hexData) a_DiameterIdentity->fromHexString(hexData->getValue());
1535   } else if(stackFormat->isDiameterURI()) {
1536     if(data) a_DiameterURI->fromPrintableString(data->getValue().c_str());
1537     else if(hexData) a_DiameterURI->fromHexString(hexData->getValue());
1538   } else if(stackFormat->isEnumerated()) {
1539     if(data) a_Enumerated->fromPrintableString(data->getValue().c_str());
1540     else if(hexData) a_Enumerated->fromHexString(hexData->getValue());
1541   } else if(stackFormat->isIPFilterRule()) {
1542     if(data) a_IPFilterRule->fromPrintableString(data->getValue().c_str());
1543     else if(hexData) a_IPFilterRule->fromHexString(hexData->getValue());
1544   } else if(stackFormat->isQoSFilterRule()) {
1545     if(data) a_QoSFilterRule->fromPrintableString(data->getValue().c_str());
1546     else if(hexData) a_QoSFilterRule->fromHexString(hexData->getValue());
1547   }
1548
1549   /////////////////////
1550   // Format specific //
1551   /////////////////////
1552   fromXMLByFormat(data, hexData, stackFormat);
1553 }
1554
1555 //------------------------------------------------------------------------------
1556 //----------------------------------------------------------------- Avp::asXML()
1557 //------------------------------------------------------------------------------
1558 anna::xml::Node* Avp::asXML(anna::xml::Node* parent) const throw() {
1559   // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1560   anna::xml::Node* result = parent->createChild("avp");
1561   // Dictionary stack avp and format:
1562   const stack::Avp *stackAvp = getStackAvp();
1563   const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1564   bool compactMode = (stackAvp && flagsOK());
1565
1566   if(compactMode) {
1567     result->createAttribute("name", stackAvp->getName());
1568   } else {
1569     result->createAttribute("code", a_id.first);
1570     result->createAttribute("vendor-code", a_id.second);
1571     result->createAttribute("flags", (int)a_flags);
1572   }
1573
1574   // Grouped special case:
1575   if(stackFormat && stackFormat->isGrouped()) {
1576     for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) avp(it)->asXML(result);
1577
1578     return result;
1579   }
1580
1581   // Data part literals:
1582   bool isHex;
1583   std::string value = getXMLdata(isHex, stackFormat);
1584
1585   if(isHex) {
1586     result->createAttribute("hex-data", value);
1587   } else {
1588     result->createAttribute("data", value);
1589     const char *alias = stackAvp->getAlias(value);
1590
1591     if(alias) result->createAttribute("alias", alias);  // additional information
1592   }
1593
1594   return result;
1595 }
1596
1597
1598 //------------------------------------------------------------------------------
1599 //----------------------------------------------------------- Avp::asXMLString()
1600 //------------------------------------------------------------------------------
1601 std::string Avp::asXMLString() const throw() {
1602   anna::xml::Node root("root");
1603   return anna::xml::Compiler().apply(asXML(&root));
1604 }
1605
1606
1607 //------------------------------------------------------------------------------
1608 //---------------------------------------------------------------- Avp::isLike()
1609 //------------------------------------------------------------------------------
1610 bool Avp::isLike(const std::string &pattern) const throw() {
1611   anna::RegularExpression re(pattern);
1612   return re.isLike(asXMLString());
1613 }