sipcon.h

Go to the documentation of this file.

/*
 * sipcon.h
 *
 * Session Initiation Protocol connection.
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 30972 $
 * $Author: rjongbloed $
 * $Date: 2013-11-26 10:02:24 +1100 (Tue, 26 Nov 2013) $
 */

#ifndef OPAL_SIP_SIPCON_H
#define OPAL_SIP_SIPCON_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal/buildopts.h>

#if OPAL_SIP

#include <rtp/rtpconn.h>
#include <sip/sippdu.h>
#include <sip/handlers.h>


class OpalSIPIMContext;


#define OPAL_OPT_FORWARD_REFER   "Forward-Refer"

#define OPAL_OPT_REFER_SUB       "Refer-Sub"

#define OPAL_OPT_PRACK_MODE      "PRACK-Mode"

#define OPAL_OPT_INITIAL_OFFER "Initial-Offer"

#define OPAL_OPT_SYMMETRIC_HOLD_PRODUCT "Symmetric-Hold-Product"

#define OPAL_OPT_ALLOW_EARLY_REPLACE "Allow-Early-Replace"

#define OPAL_OPT_EXTERNAL_SDP "External-SDP"

#define SIP_HEADER_PREFIX      "SIP-Header:"
#define SIP_HEADER_REPLACES    SIP_HEADER_PREFIX"Replaces"
#define SIP_HEADER_REFERRED_BY SIP_HEADER_PREFIX"Referred-By"
#define SIP_HEADER_CONTACT     SIP_HEADER_PREFIX"Contact"

#define OPAL_SIP_REFERRED_CONNECTION "Referred-Connection"



class SIPConnection : public OpalRTPConnection, public SIPTransactionOwner
{
    PCLASSINFO(SIPConnection, OpalRTPConnection);
  public:

    struct Init {
      Init(OpalCall & call, SIPEndPoint & endpoint)
        : m_call(call)
        , m_endpoint(endpoint)
        , m_userData(NULL)
        , m_invite(NULL)
        , m_options(0)
        , m_stringOptions(NULL)
        { }

      OpalCall    & m_call;      
      SIPEndPoint & m_endpoint;  
      PString       m_token;     
      SIPURL        m_address;   
      void        * m_userData;  
      SIP_PDU     * m_invite;    
      unsigned m_options;        
      OpalConnection::StringOptions * m_stringOptions;  
    };

    SIPConnection(
      const Init & init         
    );

    ~SIPConnection();

    virtual bool IsNetworkConnection() const { return true; }

    virtual PString GetPrefixName() const;

    virtual PString GetIdentifier() const;

    virtual void OnApplyStringOptions();

    virtual PBoolean SetUpConnection();

    virtual OpalTransportAddress GetRemoteAddress() const { return m_remoteAddress; }

    virtual PString GetRemoteIdentity() const;

    virtual PString GetDestinationAddress();

    virtual PString GetCalledPartyURL();

    virtual PString GetAlertingType() const;

    virtual bool SetAlertingType(const PString & info);

    virtual PString GetCallInfo() const;

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

    virtual bool Hold(
      bool fromRemote,  
      bool placeOnHold  
    );

    virtual bool IsOnHold(
      bool fromRemote  
    );

    virtual PBoolean SetAlerting(
      const PString & calleeName,   
      PBoolean withMedia            
    );

    virtual PBoolean SetConnected();

    virtual OpalMediaFormatList GetMediaFormats() const;
    
    virtual bool RequireSymmetricMediaStreams() const;

#if OPAL_T38_CAPABILITY

    virtual bool SwitchFaxMediaStreams(
      bool toT38  
    );
#endif

    virtual OpalMediaStream * CreateMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      PBoolean isSource                        
    );

    virtual OpalMediaStreamPtr OpenMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      bool isSource                        
    );

    virtual void OnClosedMediaStream(
      const OpalMediaStream & stream     
    );

    virtual bool GetMediaTransportAddresses(
      const OpalMediaType & mediaType,       
      OpalTransportAddressArray & transports 
    ) const;

    virtual void OnPatchMediaStream(
      PBoolean isSource,        
      OpalMediaPatch & patch    
    );

    virtual void OnPauseMediaStream(
      OpalMediaStream & strm,     
      bool paused                 
    );

    virtual void OnReleased();

    virtual PBoolean ForwardCall(
      const PString & forwardParty   
    );

    virtual SendUserInputModes GetRealSendUserInputMode() const;

    virtual PBoolean SendUserInputString(
      const PString & value                   
    );

    PBoolean SendUserInputTone(char tone, unsigned duration);

    virtual void OnTransactionFailed(
      SIPTransaction & transaction
    );

    virtual void OnReceivedPDU(SIP_PDU & pdu);

    virtual void OnReceivedINVITE(SIP_PDU & pdu);

    virtual void OnReceivedReINVITE(SIP_PDU & pdu);

    virtual void OnReceivedACK(SIP_PDU & pdu);
  
    virtual void OnReceivedOPTIONS(SIP_PDU & pdu);

    virtual void OnReceivedNOTIFY(SIP_PDU & pdu);

    virtual void OnAllowedEventNotify(
      const PString & eventName  
    );

    virtual void OnReceivedREFER(SIP_PDU & pdu);
  
    virtual void OnReceivedINFO(SIP_PDU & pdu);

    virtual void OnReceivedPING(SIP_PDU & pdu);

    virtual void OnReceivedPRACK(SIP_PDU & pdu);

    virtual void OnReceivedBYE(SIP_PDU & pdu);
  
    virtual void OnReceivedCANCEL(SIP_PDU & pdu);
  
    virtual bool OnReceivedResponseToINVITE(
      SIPTransaction & transaction,
      SIP_PDU & response
    );

    virtual void OnReceivedResponse(
      SIPTransaction & transaction,
      SIP_PDU & response
    );

    virtual void OnReceivedTrying(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnReceivedRinging(SIPTransaction & transaction, SIP_PDU & pdu);
  
    virtual void OnReceivedSessionProgress(SIPTransaction & transaction, SIP_PDU & pdu);
  
    virtual PBoolean OnReceivedAuthenticationRequired(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnReceivedRedirection(SIP_PDU & pdu);

    virtual void OnReceivedOK(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnCreatingINVITE(SIPInvite & pdu);

    enum TypeOfINVITE {
      IsNewINVITE,
      IsDuplicateINVITE,
      IsReINVITE,
      IsLoopedINVITE
    };

    TypeOfINVITE CheckINVITE(
      const SIP_PDU & pdu
    ) const;

    bool SendOPTIONS(
      const SIPOptions::Params & params,  
      SIP_PDU * reply = NULL              
    );

    bool SendINFO(
      const SIPInfo::Params & params,  
      SIP_PDU * reply = NULL              
    );

    OpalTransportAddress GetDefaultSDPConnectAddress(WORD port = 0) const;

    SIPEndPoint & GetEndPoint() const { return SIPTransactionOwner::m_endpoint; }
    SIPAuthentication * GetAuthenticator() const { return m_authentication; }

    enum PRACKMode {
      e_prackDisabled,  
      e_prackSupported, 
      e_prackRequired   
    };
    PRACKMode GetPRACKMode() const { return m_prackMode; }

    virtual unsigned GetAllowedMethods() const;

    bool DoesRemoteAllowMethod(SIP_PDU::Methods method) const { return (m_allowedMethods&(1<<method)) != 0; }

#if OPAL_VIDEO

    virtual PBoolean OnMediaControlXML(SIP_PDU & pdu);
#endif

    virtual bool OnMediaCommand(
      OpalMediaStream & stream,         
      const OpalMediaCommand & command  
    );

    // Overrides from SIPTransactionOwner
    virtual PString GetAuthID() const;


    virtual void OnStartTransaction(SIPTransaction & transaction);
    virtual void OnReceivedMESSAGE(SIP_PDU & pdu);
    virtual void OnReceivedSUBSCRIBE(SIP_PDU & pdu);

    PString GetLocalPartyURL() const;

    virtual void PrintOn(ostream & strm) const { OpalRTPConnection::PrintOn(strm); }

  protected:
    virtual bool GarbageCollection();
    typedef SIPPoolTimer<SIPConnection> PoolTimer;
    void OnSessionTimeout();
    void OnInviteResponseRetry();
    void OnInviteResponseTimeout();
    void OnInviteCollision();

    void OnReceivedAlertingResponse(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
    virtual bool OnSendOfferSDP(
      SDPSessionDescription & sdpOut,
      bool offerCurrentOnly
    );
    virtual bool OnSendOfferSDPSession(
      unsigned sessionID,
      SDPSessionDescription & sdpOut,
      bool offerOpenMediaStreamOnly
    );

    virtual bool OnSendAnswerSDP(
      SDPSessionDescription & sdpOut
    );
    virtual bool OnSendAnswerSDP(
      const SDPSessionDescription & sdpOffer,
      SDPSessionDescription & sdpAnswer
    );
    virtual bool OnSendAnswerSDPSession(
      const SDPSessionDescription & sdpIn,
      unsigned sessionIndex,
      SDPSessionDescription & sdpOut
    );

    virtual bool OnReceivedAnswerSDP(
      SIP_PDU & response,
      SIPTransaction * transaction
    );
    virtual bool OnReceivedAnswerSDPSession(
      SDPSessionDescription & sdp,
      unsigned sessionId,
      bool & multipleFormats
    );

    virtual OpalMediaSession * SetUpMediaSession(
      const unsigned rtpSessionId,
      const OpalMediaType & mediaType,
      const SDPMediaDescription & mediaDescription,
      OpalTransportAddress & localAddress,
      bool & remoteChanged
    );

    bool SendReINVITE(PTRACE_PARAM(const char * msg));
    bool StartPendingReINVITE();

    friend class SIPInvite;
    PDECLARE_WriteConnectCallback(SIPConnection, WriteINVITE);

    virtual void SendDelayedACK(bool force);
    void OnDelayedAckTimeout();

    virtual bool SendInviteOK();
    virtual PBoolean SendInviteResponse(
      SIP_PDU::StatusCodes code,
      const SDPSessionDescription * sdp = NULL
    );
    virtual void AdjustInviteResponse(
      SIP_PDU & response
    );

    void UpdateRemoteAddresses();
#if OPAL_SRTP
    virtual bool CanDoSRTP() const { return m_dialog.GetRemoteTransportAddress(m_dnsEntry).GetProtoPrefix() == OpalTransportAddress::TlsPrefix(); }
#endif

    void NotifyDialogState(
      SIPDialogNotification::States state,
      SIPDialogNotification::Events eventType = SIPDialogNotification::NoEvent,
      unsigned eventCode = 0
    );

    virtual bool InviteConferenceParticipant(const PString & conf, const PString & dest);

    // Member variables
    unsigned              m_allowedMethods;
    PStringSet            m_allowedEvents;

    enum HoldState {
      eHoldOff,
      eRetrieveInProgress,

      // Order is important!
      eHoldOn,
      eHoldInProgress
    };
    HoldState             m_holdToRemote;
    bool                  m_holdFromRemote;
    PString               m_forwardParty;
    OpalTransportAddress  m_remoteAddress;
    PString               m_remoteIdentity;
    SIPURL                m_contactAddress;
    SIPURL                m_ciscoRemotePartyID;

    SIP_PDU             * m_lastReceivedINVITE;
    SIP_PDU             * m_delayedAckInviteResponse;
    PoolTimer             m_delayedAckTimer;
    PTimeInterval         m_delayedAckTimeout;
    SIP_PDU             * m_lastSentAck;
    time_t                m_sdpSessionId;
    unsigned              m_sdpVersion; // Really a sequence number
    bool                  m_needReINVITE;
    bool                  m_handlingINVITE;
    bool                  m_resolveMultipleFormatReINVITE;
    bool                  m_symmetricOpenStream;
    OpalGloballyUniqueID  m_dialogNotifyId;
    int                   m_appearanceCode;
    PString               m_alertInfo;
    PoolTimer             m_sessionTimer;

    PRACKMode      m_prackMode;
    bool           m_prackEnabled;
    unsigned       m_prackSequenceNumber;
    std::queue<SIP_PDU> m_responsePackets;
    PoolTimer      m_responseFailTimer;
    PoolTimer      m_responseRetryTimer;
    unsigned       m_responseRetryCount;
    PoolTimer      m_inviteCollisionTimer;

    bool                      m_referInProgress;
    PSafeList<SIPTransaction> m_forkedInvitations; // Not for re-INVITE
    PSafeList<SIPTransaction> m_pendingInvitations; // For re-INVITE

    enum {
      ReleaseWithBYE,
      ReleaseWithCANCEL,
      ReleaseWithResponse,
      ReleaseWithNothing,
    } releaseMethod;

    OpalMediaFormatList m_remoteFormatList;
    OpalMediaFormatList m_answerFormatList;
    bool SetRemoteMediaFormats(SIP_PDU * pdu);

    std::map<std::string, SIP_PDU *> m_responses;

#if OPAL_HAS_SIPIM
    PSafePtr<OpalSIPIMContext> m_imContext;
#endif

#if OPAL_VIDEO
    PSimpleTimer m_infoPictureFastUpdateTimer;
#endif

    enum {
      UserInputMethodUnknown,
      ReceivedRFC2833,
      ReceivedINFO
    } m_receivedUserInputMethod;
    void OnUserInputInlineRFC2833(OpalRFC2833Info & info, INT type);


  private:
    P_REMOVE_VIRTUAL_VOID(OnCreatingINVITE(SIP_PDU&));
    P_REMOVE_VIRTUAL_VOID(OnReceivedTrying(SIP_PDU &));
    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIPURL & /*from*/, const SIP_PDU & /*pdu*/));
    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIP_PDU & /*pdu*/));

  friend class SIPTransaction;
  friend class SIP_RTP_Session;
};


#endif // OPAL_SIP

#endif // OPAL_SIP_SIPCON_H


// End of File ///////////////////////////////////////////////////////////////