Url.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2013  SIPez LLC. All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _Url_h_
#define _Url_h_

// SYSTEM INCLUDES
//#include <...>

// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlString.h"
#include "utl/UtlRegex.h"
class UtlDList;

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class NameValuePair ;


class Url
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
   
   typedef enum
      {
         UnknownUrlScheme,  
         SipUrlScheme,      
         SipsUrlScheme,     
         HttpUrlScheme,     
         HttpsUrlScheme,    
         FtpUrlScheme,      
         FileUrlScheme,     
         MailtoUrlScheme,   
         RtspUrlScheme,     
         NUM_SUPPORTED_URL_SCHEMES
      }  Scheme;
/* ============================ CREATORS ================================== */

   Url(const char* urlString = NULL, 
       UtlBoolean isAddrSpec = FALSE 
       );

    Url(const Url& rUrl);

    virtual
    ~Url();

/* ============================ MANIPULATORS ============================== */

    Url& operator=(const Url& rhs);


    Url& operator=(const char* urlString);

    void fromString(const UtlString& urlString,
                    UtlBoolean isAddrSpec = FALSE
                    );

    //  as a field in a header.
    void toString(UtlString& urlString) const;

    //  as a field in a header.
    UtlString toString() const;

    void dump();

    void reset();

    void removeParameters();

/* ============================ ACCESSORS ================================= */

    void getIdentity(UtlString& identity) const;
    void getUrlType(UtlString& urlProtocol) const;
    void setUrlType(const char* urlProtocol);

    void getDisplayName(UtlString& displayName) const;

    void setDisplayName(const char* displayName);

    void getUserId(UtlString& userId) const;

    void setUserId(const char* userId);

    UtlBoolean getPassword(UtlString& userId) const;

    void setPassword(const char* userId);
    void getHostAddress(UtlString& address) const;

    void getHostWithPort(UtlString& domain) const;
    
    void setHostAddress(const char* address);

    int getHostPort() const;

    void setHostPort(int port);

    UtlBoolean getPath(UtlString& path,
                       UtlBoolean getStyle = FALSE 
                       );


    void setPath(const char* path);
    UtlBoolean getUrlParameter(const char* name,  
                               UtlString& value,  
                               int index = 0 
                               );
    UtlBoolean getUrlParameter(int urlIndex,    
                               UtlString& name,  
                               UtlString& value  
                               );

    void setUrlParameter(const char* name, const char* value);

    void removeUrlParameters();

    void removeUrlParameter(const char* name);


    UtlBoolean getUrlParameters(int iMaxReturn, 
                               UtlString *pNames, 
                               UtlString *pValues, 
                               int& iActualReturn);


    UtlBoolean getHeaderParameter(const char* name, 
                                 UtlString& value, 
                                 int index = 0);


    UtlBoolean getHeaderParameter(int headerIndex, 
                                 UtlString& headerName, 
                                 UtlString& headerValue);

    void setHeaderParameter(const char* name,  
                            const char* value  
                            );
    void removeHeaderParameters();

    void removeHeaderParameter(const char* name);


    UtlBoolean getHeaderParameters(int iMaxReturn, UtlString *pNames, UtlString *pValues, int& iActualReturn);



    UtlBoolean getFieldParameter(const char* name, 
                                UtlString& value, 
                                int index = 0) const;


    UtlBoolean getFieldParameter(int fieldIndex, 
                                UtlString& name, 
                                UtlString& value);


    void setFieldParameter(const char* name, 
                           const char* value);

    void removeFieldParameters();

    void removeFieldParameter(const char* name);


    UtlBoolean getFieldParameters(int iMaxReturn, 
                                 UtlString *pNames, 
                                 UtlString *pValues, 
                                 int& iActualReturn);

    void includeAngleBrackets();

    void removeAngleBrackets();
    static void gen_value_escape(UtlString& escapedText);

    static void gen_value_unescape(UtlString& escapedText);

    void getUri(UtlString& Uri);

/* ============================ INQUIRY =================================== */


   static UtlBoolean isDigitString(const char* dialedCharacters);

   UtlBoolean isUserHostPortEqual(const Url& uri,
                                  int impliedPort = PORT_NONE 
                                  ) const ;
   UtlBoolean isUserHostEqual(const Url& uri) const ;
   UtlBoolean isIncludeAngleBracketsSet() const ;
   Scheme scheme( const UtlString& schemeName );

   const char* schemeName( Scheme scheme );

   Scheme getScheme() const;

   void setScheme(Scheme scheme);
   

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   void parseString(const char* urlString, 
                    UtlBoolean isAddrSpec = FALSE  
                    );

   Scheme    mScheme;

   UtlString mDisplayName;
   UtlString mUserId;
   UtlString mPassword;
   UtlBoolean mPasswordSet;
   UtlString mHostAddress;
   int mHostPort;
   UtlString mPath;

   UtlString mRawUrlParameters;
   bool      parseUrlParameters();//< lazy parser for url parameters
   UtlDList* mpUrlParameters;

   UtlString mRawHeaderOrQueryParameters;
   bool      parseHeaderOrQueryParameters();//< lazy parser for header or query parameters
   UtlDList* mpHeaderOrQueryParameters;

   UtlString mRawFieldParameters;
   bool      parseFieldParameters(); //< lazy parser for field parameters
   UtlDList* mpFieldParameters;

   UtlBoolean mAngleBracketsIncluded;
};

/* ============================ INLINE METHODS ============================ */

#endif  // _Url_h_