statusmsg.cxx

SIP（Session Initiation Protocol）是由IETF定义

/* ====================================================================
 * 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 [e-mail].
 *
 * 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/>.
 *
 */

static const char* const StatusMsg_cxx_Version =
    "$Id: StatusMsg.cxx,v 1.132.2.1 2003/02/25 01:18:17 bko Exp $";

#include "global.h"
#include "support.hxx"
#include "InviteMsg.hxx"
#include "SipAllow.hxx"
#include "SipContact.hxx"
#include "SipOsp.hxx"
#include "SipRequire.hxx"
#include "SipRetryAfter.hxx"
#include "SipRoute.hxx"
#include "SipSubsNotifyEvent.hxx"
#include "SipUnsupported.hxx"
#include "SipUserAgent.hxx"
#include "SipVia.hxx"
#include "StatusMsg.hxx"
#include "RandomHex.hxx"

using namespace Vocal;


#define NUM_TAG_RANDOMNESS 4 //32 bits of randomness.


StatusMsg::StatusMsg()
        :
        SipMsg(),
        statusLine()
{
   
}


StatusMsg::StatusMsg(const StatusMsg& src)
        :
        SipMsg(src),
        statusLine(src.statusLine)
{
}


StatusMsg::~StatusMsg()
{
}


StatusMsg::StatusMsg(const Data & data) throw (SipParserException&)
        :
        SipMsg(),
        statusLine()
{
    try
    {
        decode(data);
    }
    catch (SipParserException& e)
    {
        cpLog(LOG_ERR, "Failed to parse the SIP msg, since: %s", 
              e.getDescription().c_str());
        throw SipParserException(e.getDescription(),
                                 __FILE__,
                                 __LINE__);
    }
}


Method StatusMsg::getType() const
{
    return SIP_STATUS;
}


const StatusMsg& StatusMsg::operator =(const StatusMsg& src)
{
    if ( &src != this)
    {
        *(static_cast < SipMsg* > (this)) = src;
	statusLine = src.statusLine;
    }
    return (*this);
}


bool StatusMsg::operator ==(const StatusMsg& src)
{
    return SipMsg::operator==(src);
}


StatusMsg::StatusMsg(SipCommand& command, int statusCode)
        :
        SipMsg(),
        statusLine()
{
    //  set the SipStatusLine.

    statusLine.setStatusCode(statusCode);

    Method meth = command.getType();

    //responses to all messages will have the below mandatory.

    copyHeader(command, SIP_VIA_HDR);
    copyHeader(command, SIP_FROM_HDR);
    copyHeader(command, SIP_TO_HDR);
    copyHeader(command, SIP_CALLID_HDR);
    copyHeader(command, SIP_CSEQ_HDR);

    if ( statusCode > 100 && statusCode < 500 )
    {
        if (!(command.getTo().getTag().length()) )
        {
	    // add the To tag only if the command does not contain a To tag already
            Data statusToTag = RandomHex::get(NUM_TAG_RANDOMNESS);
	    cpLog(LOG_DEBUG_STACK, "To tag generated by stack is : %s", statusToTag.logData());  
	    
	    //set this in the To field.
	    SipTo tempTo = getTo();
	    tempTo.setTag(statusToTag);
	    setTo(tempTo);
	}
    }
    if ( statusCode > 100 && statusCode <= 200)
    {
        //copy record route.
        if (command.getNumRecordRoute())
        {
            copyHeader(command, SIP_RECORD_ROUTE_HDR);
        }

        if (meth == SIP_SUBSCRIBE)
        {
            //if subscribe, copy all the event headers.
            copySubsNotifyEvent(command);
        }
    }

    if ((meth == SIP_INVITE ) && ( statusCode == 302))
    {
        copyDiversionList( command );
    }
    //set content Length as zero. Will be later reset if any mime information
    //is added to this status message.
    setContentLength(ZERO_CONTENT_LENGTH);
}

    
bool 
StatusMsg::isStatusCodes(const Data& code)
{
    if ( (code.convertInt() >= 100) && (code.convertInt() <= 700) )
    {
        return true;
    }
    else
    {
        return false;
    }
}


bool 
StatusMsg::isprotocolSIP(const Data& pheader)
{
    bool ret = false;
    Data header = pheader;
    Data protoVersion;
    int value = header.match("/", &protoVersion, true);
    if (value == FOUND)
    {
        if (protoVersion == DEFAULT_PROTOCOL)
        {
            ret = true;
        }
        else
        {
            ret = false;
        }
    }
    else
    {
        ret = false;
    }
    return ret;
}


void 
StatusMsg::parseStartLine(const Data& plin)
{ 
  Data lin = plin;
  Data line1 = plin;
  int fieldvalue1;
  Data header1;
  fieldvalue1 = lin.match(SP, &header1, false);
  if (fieldvalue1 == FOUND)
    {
      if (fieldvalue1 == FOUND)
	{
	  if (isprotocolSIP(header1))
	    {
	      //scan till the second SP, which will give the status-code.
	      Data lstatusLine = line1;
	      lstatusLine.match(SP, &header1, true);
	      lstatusLine.match(SP, &header1, true);
	      if (isStatusCodes(header1))
		{
		  setStatusLine(line1);
		}
	    }
	}
    }
  
}


void
StatusMsg::decode(const Data & sltdata)
{
    // new, revised decode

    // get the first line, and parse

    Data rawMsg = sltdata;

    bool noMatch = false;
    Data line = rawMsg.getLine(&noMatch);

    parseStartLine(line);

    try
    {
        // pass the rest up to SipMsg::parseHeaders()
        SipMsg::parse(rawMsg);
    }
    catch(VException& e)
    {
        cpLog(LOG_ERR, "Failed to parse the SIP msg, since: %s", 
              e.getDescription().c_str());
        throw SipParserException(e.getDescription(),
                                 __FILE__,
                                 __LINE__);
    }
    catch(...)
    {
        cpLog(LOG_ERR, "Failed to parse the SIP msg for unknown reason");
        throw SipParserException("unknown reason",
                                 __FILE__,
                                 __LINE__);
    }
}

/*------------------------------ SipStatusLine ------------------------------*/


const SipStatusLine&
StatusMsg::getStatusLine() const
{
    return statusLine;
}

void StatusMsg::setStatusLine( const SipStatusLine& newstatusLine)
{
    statusLine = newstatusLine;
}

    
void StatusMsg::setStatusLine( const Data& newstatusLine)
{
    statusLine.decode(newstatusLine);
}


void StatusMsg::setStatusDetails()
{
}


void StatusMsg::setReasonPhrase(const Data& reason)
{
    statusLine.setReasonPhrase(reason);
}

Data StatusMsg::getReasonPhrase() const
{
    return (statusLine.getReasonPhrase());
}


    
/*------------------------------ SipWarning ------------------------------*/


int StatusMsg::getNumWarning() const
{
    return myHeaderList.getNumHeaders(SIP_WARNING_HDR);
}


const SipWarning& StatusMsg::getWarning( int i /*Default Arguments */) const
{
    Sptr<SipWarning> x;
    myHeaderList.getParsedHeader(x, SIP_WARNING_HDR, i);