MasterProfile.cxx

Go to the documentation of this file.

 
#include "resip/dum/Profile.hxx"
#include "resip/dum/MasterProfile.hxx"
#include "resip/stack/HeaderTypes.hxx"
#include "rutil/Logger.hxx"
 
using namespace resip;
#define RESIPROCATE_SUBSYSTEM Subsystem::DUM
 
 
// Be sure to look at the documentation of the accessors for 
// the members being set by this constructor in the .hxx file 
// for the implications of these default values.
 
MasterProfile::MasterProfile() : 
   mValidateContentEnabled(true),
   mValidateContentLanguageEnabled(false),
   mValidateAcceptEnabled(false),
   mAllowBadRegistrationEnabled(false),
   mCheckReqUriInMergeDetectionEnabled(false),
   mUacReliableProvisionalMode(Never),
   mUasReliableProvisionalMode(Never),
   mServerRegistrationMinExpires(0),
   mServerRegistrationMaxExpires(UINT_MAX),
   mServerRegistrationDefaultExpires(3600),
   mAdditionalTransactionTerminatingResponsesEnabled(false)
{
   // Default settings
   addSupportedMimeType(INVITE, Mime("application", "sdp"));
   addSupportedMimeType(OPTIONS, Mime("application", "sdp"));
   addSupportedMimeType(PRACK, Mime("application", "sdp"));
   addSupportedMimeType(UPDATE, Mime("application", "sdp"));
   addSupportedLanguage(Token("en"));
   addSupportedMethod(INVITE);
   addSupportedMethod(ACK);
   addSupportedMethod(CANCEL);
   addSupportedMethod(OPTIONS);
   addSupportedMethod(BYE);
   addSupportedMethod(UPDATE);
   addSupportedScheme(Symbols::Sip);
   // urn: (e.g. RFC 5031 emergency service URNs) is intentionally not
   // added to the default supported schemes. An application that wants 
   // it should call addSupportedScheme(Symbols::Urn) itself.
}
 
void 
MasterProfile::addSupportedScheme(const Data& scheme)
{
   mSupportedSchemes.insert(scheme);
}
 
bool 
MasterProfile::isSchemeSupported(const Data& scheme) const
{
   return mSupportedSchemes.find(scheme) != mSupportedSchemes.end();
}
 
void 
MasterProfile::clearSupportedSchemes() noexcept
{
   mSupportedSchemes.clear();
}
 
void 
MasterProfile::addSupportedMethod(const MethodTypes& method)
{
   mSupportedMethodTypes.insert(method);
   mSupportedMethods.push_back(Token(getMethodName(method)));
}
 
void 
MasterProfile::removeSupportedMethod(const MethodTypes& method)
{
   mSupportedMethodTypes.erase(method);
   for (Tokens::iterator i = mSupportedMethods.begin();
            i != mSupportedMethods.end(); ++i)
   {
       if (getMethodType(i->value()) == method)
       {
           mSupportedMethods.erase(i);
           break;
       }
   }
 
   // Should we clear the mimetypes as well?
   // clearSupportedMimeTypes(method);
}
 
bool 
MasterProfile::isMethodSupported(MethodTypes method) const
{
   return mSupportedMethodTypes.find(method) != mSupportedMethodTypes.end();
}
 
Tokens 
MasterProfile::getAllowedMethods() const
{
   return mSupportedMethods;
}
 
Data
MasterProfile::getAllowedMethodsData() const
{
   Data result;
   
   for (Tokens::const_iterator i = mSupportedMethods.begin();
        i != mSupportedMethods.end(); ++i)
   {
      if (i != mSupportedMethods.begin())
      {
         result += Symbols::COMMA[0];
      }
      result += i->value();
   }
   
   return result;
}
 
void 
MasterProfile::clearSupportedMethods() noexcept
{
   mSupportedMethodTypes.clear();
   mSupportedMethods.clear();
}
 
void 
MasterProfile::addSupportedOptionTag(const Token& tag)
{
   if (tag == Token(Symbols::C100rel))
   {
      //use setUasReliableProvisionalMode and setUacReliableProvisionalMode
      resip_assert(0);
   }
   mSupportedOptionTags.push_back(tag);
}
 
Tokens 
MasterProfile::getUnsupportedOptionsTags(const Tokens& requiresOptionTags)
{
   Tokens tokens;
   for (Tokens::const_iterator i=requiresOptionTags.begin(); i != requiresOptionTags.end(); ++i)
   {
      if (!i->isWellFormed())
      {
         tokens.push_back(Token("malformedTag"));
      }
      else if (*i == Token(Symbols::C100rel) )
      {
         if (mUasReliableProvisionalMode == Never)
         {
            tokens.push_back(*i);
         }
      }
      // if this option is not supported
      else if (!mSupportedOptionTags.find(*i))
      {
         tokens.push_back(*i);
      }
   }
   
   return tokens;
}
 
Tokens 
MasterProfile::getSupportedOptionTags() const
{
   return mSupportedOptionTags;
}
 
void 
MasterProfile::clearSupportedOptionTags() noexcept
{
   mSupportedOptionTags.clear();
}
 
void
MasterProfile::setUacReliableProvisionalMode(ReliableProvisionalMode mode) noexcept
{
   mUacReliableProvisionalMode = mode;
}
 
void
MasterProfile::setUasReliableProvisionalMode(ReliableProvisionalMode mode) noexcept
{
  mUasReliableProvisionalMode = mode;
}
 
MasterProfile::ReliableProvisionalMode
MasterProfile::getUacReliableProvisionalMode() const noexcept
{
   return mUacReliableProvisionalMode;
}
 
MasterProfile::ReliableProvisionalMode
MasterProfile::getUasReliableProvisionalMode() const noexcept
{
   return mUasReliableProvisionalMode;
}
 
void 
MasterProfile::addSupportedMimeType(const MethodTypes& method, const Mime& mimeType)
{
   mSupportedMimeTypes[method].push_back(mimeType);
}
 
bool 
MasterProfile::removeSupportedMimeType(const MethodTypes& method, const Mime& mimeType)
{
   std::map<MethodTypes, Mimes>::iterator foundMethod = mSupportedMimeTypes.find(method);
   if (foundMethod != mSupportedMimeTypes.end())
   {
      for (Mimes::iterator i = foundMethod->second.begin();
         i != foundMethod->second.end(); ++i)
      {
         if (mimeType.isEqual(*i))
         {
            foundMethod->second.erase(i);
            return true;
         }
      }
   }
   return false;
}
 
bool 
MasterProfile::isMimeTypeSupported(const MethodTypes& method, const Mime& mimeType)
{
   if(!mimeType.isWellFormed())
   {
      return false;
   }
   
   std::map<MethodTypes, Mimes>::iterator found = mSupportedMimeTypes.find(method); 
   if (found != mSupportedMimeTypes.end()) 
   { 
      return found->second.find(mimeType); 
   } 
   return false; 
}
 
Mimes 
MasterProfile::getSupportedMimeTypes(const MethodTypes& method)
{
   std::map<MethodTypes, Mimes>::iterator found = mSupportedMimeTypes.find(method); 
   if (found != mSupportedMimeTypes.end()) 
   { 
      return found->second; 
   } 
   return Mimes(); 
}
 
void 
MasterProfile::clearSupportedMimeTypes(const MethodTypes& method)
{
   std::map<MethodTypes, Mimes>::iterator found = mSupportedMimeTypes.find(method); 
   if (found != mSupportedMimeTypes.end()) 
   { 
      found->second.clear(); 
   } 
}
 
void 
MasterProfile::clearSupportedMimeTypes() noexcept
{
   mSupportedMimeTypes.clear();
}
 
void 
MasterProfile::addSupportedEncoding(const Token& encoding)
{
   mSupportedEncodings.push_back(encoding);
}
 
bool 
MasterProfile::isContentEncodingSupported(const Token& encoding) const
{
   return encoding.isWellFormed() && mSupportedEncodings.find(encoding);
}
 
Tokens 
MasterProfile::getSupportedEncodings() const
{
   return mSupportedEncodings;
}
 
void 
MasterProfile::clearSupportedEncodings() noexcept
{
   mSupportedEncodings.clear();
}
 
void 
MasterProfile::addSupportedLanguage(const Token& lang)
{
   mSupportedLanguages.push_back(lang);
}
 
bool 
MasterProfile::isLanguageSupported(const Tokens& langs) const
{
   for (Tokens::const_iterator i=langs.begin(); i != langs.end(); ++i)
   {
      if (!i->isWellFormed() || mSupportedLanguages.find(*i) == false)
      {
         return false;
      }
   }
   return true;
}
 
Tokens 
MasterProfile::getSupportedLanguages() const
{
   return mSupportedLanguages;
}
 
void 
MasterProfile::clearSupportedLanguages() noexcept
{
   mSupportedLanguages.clear();
}
 
void 
MasterProfile::addAllowedEvent(const Token& event)
{
   mAllowedEvents.push_back(event);
}
 
bool 
MasterProfile::isEventAllowed(const Tokens& events) const
{
   for (Tokens::const_iterator i=events.begin(); i != events.end(); ++i)
   {
      if (!i->isWellFormed() || mAllowedEvents.find(*i) == false)
      {
         return false;
      }
   }
   return true;
}
 
Tokens 
MasterProfile::getAllowedEvents() const
{
   return mAllowedEvents;
}
 
void 
MasterProfile::clearAllowedEvents() noexcept
{
   mAllowedEvents.clear();
}
 
bool& 
MasterProfile::validateContentEnabled() noexcept
{
   return mValidateContentEnabled;   
}
 
bool 
MasterProfile::validateContentEnabled() const noexcept
{
   return mValidateContentEnabled;   
}
 
bool& 
MasterProfile::validateContentLanguageEnabled() noexcept
{
   return mValidateContentLanguageEnabled;   
}
 
bool 
MasterProfile::validateContentLanguageEnabled() const noexcept
{
   return mValidateContentLanguageEnabled;   
}
 
bool& 
MasterProfile::validateAcceptEnabled() noexcept
{
   return mValidateAcceptEnabled;   
}
 
bool 
MasterProfile::validateAcceptEnabled() const noexcept
{
   return mValidateAcceptEnabled;   
}
 
bool 
MasterProfile::allowBadRegistrationEnabled() const noexcept
{
   return mAllowBadRegistrationEnabled;   
}
 
bool& 
MasterProfile::allowBadRegistrationEnabled() noexcept
{
   return mAllowBadRegistrationEnabled;   
}
 
  
uint32_t &
MasterProfile::serverRegistrationMinExpiresTime() noexcept
{
   return mServerRegistrationMinExpires;
}
 
uint32_t 
MasterProfile::serverRegistrationMinExpiresTime() const noexcept
{
   return mServerRegistrationMinExpires;
}
 
uint32_t &
MasterProfile::serverRegistrationMaxExpiresTime() noexcept
{
   return mServerRegistrationMaxExpires;
}
 
uint32_t 
MasterProfile::serverRegistrationMaxExpiresTime() const noexcept
{
   return mServerRegistrationMaxExpires;
}
 
uint32_t &
MasterProfile::serverRegistrationDefaultExpiresTime() noexcept
{
   return mServerRegistrationDefaultExpires;
}
 
uint32_t 
MasterProfile::serverRegistrationDefaultExpiresTime() const noexcept
{
   return mServerRegistrationDefaultExpires;
}
 
bool 
MasterProfile::checkReqUriInMergeDetectionEnabled() const noexcept
{
   return mCheckReqUriInMergeDetectionEnabled;   
}
 
bool& 
MasterProfile::checkReqUriInMergeDetectionEnabled() noexcept
{
   return mCheckReqUriInMergeDetectionEnabled;   
}
 
UserProfile*
MasterProfile::clone() const
{
   return new MasterProfile(*this);
}
 
bool& MasterProfile::additionalTransactionTerminatingResponsesEnabled() noexcept
{
  return mAdditionalTransactionTerminatingResponsesEnabled;
}
 
bool MasterProfile::additionalTransactionTerminatingResponsesEnabled() const noexcept
{
  return mAdditionalTransactionTerminatingResponsesEnabled;
}
 
void MasterProfile::addAdditionalTransactionTerminatingResponses(int code)
{
  DebugLog(<< "MasterProfile::addAdditionalTransactionTerminatingResponses" << "added code: " << code);
  mAdditionalTransactionTerminatingResponsess.insert(code);
}
 
bool MasterProfile::isAdditionalTransactionTerminatingResponse(int code) const
{
  bool isAllowed = (mAdditionalTransactionTerminatingResponsess.end() != mAdditionalTransactionTerminatingResponsess.find(code));
 
  DebugLog(<< "MasterProfile::isAdditionalTransactionTerminatingResponse" << "is code " << code << " allowed: " << isAllowed);
  return isAllowed;
}
 
const std::set<int>& MasterProfile::getAdditionalTransactionTerminatingResponses() const
{
  return mAdditionalTransactionTerminatingResponsess;
}
 
void MasterProfile::clearAdditionalTransactionTerminatingResponses() noexcept
{
  mAdditionalTransactionTerminatingResponsess.clear();
}
 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. 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.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY 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.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */