//%2007////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
//%/////////////////////////////////////////////////////////////////////////////
 
#ifndef Pegasus_HostAddress_h
#define Pegasus_HostAddress_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/Linkage.h>
#include <Pegasus/Common/String.h>
#include <Pegasus/Common/Socket.h>

#ifdef PEGASUS_OS_VMS
#include <netinet/in6.h>
#endif

PEGASUS_NAMESPACE_BEGIN

#define PEGASUS_INET_ADDRSTR_LEN 16
#define PEGASUS_INET6_ADDRSTR_LEN 46

#define PEGASUS_IPV4_LOOPBACK_ADDRESS "127.0.0.1"
#define PEGASUS_IPV6_LOOPBACK_ADDRESS  "::1"
#define PEGASUS_IPV6_LOOPBACK_INIT {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1}
#define PEGASUS_IPV4_LOOPBACK_INIT 0x7F000001


/**
    This class is used to store the host address. HostAddress can be Hostname or
    IPv4 address or IPv6 address.
*/

class PEGASUS_COMMON_LINKAGE HostAddress
{
public:

    /**
        Address types that HostAddress can have.
    */
    enum
    {
        AT_INVALID,
        AT_IPV4 = AF_INET,
#ifdef PEGASUS_ENABLE_IPV6
        AT_IPV6 = AF_INET6,
#endif
        AT_HOSTNAME         
    }; 

    /**
        Port Numbers. Values for Max, valid and unspecified ports. 
    */
    enum
    {
        PORT_UNSPECIFIED =  Uint32(-2),
        PORT_INVALID = Uint32(-1),
        MAX_PORT_NUMBER = 65535
    };

    HostAddress();
    ~HostAddress();

    /**
        Constructor. addrStr can be HostName:Port or IPv4Address:Port or
        [IPv6Address:Port] or HostName or IPv4Address or [IPv6Address].
        Note that IPv6 Addresses are represented in the form of [IPv6Address].
        For Example: [::1], [::ffff:1.2.3.4]
        
    */ 
    HostAddress(const String &addrStr);
    HostAddress(const HostAddress &rhs);
    HostAddress& operator =(const HostAddress &rhs);
 
    void setHostAddress(const String &addrStr);

    /**
        Returns true if the address is valid. If vaild it can be HostName
        or IPv4Address or IPv6Address.
    */
    Boolean isValid();

    /**
        Verifies given ipv4Address and returns true if it is valid.
    */
    static Boolean isValidIPV4Address(const String &ipv4Address);

#ifdef PEGASUS_ENABLE_IPV6
    /**
        Verifies given ipv6Address and returns true if it is valid.
    */
    static Boolean isValidIPV6Address(const String &ipv6Address);
#endif

    /**
        Verifies given hostName and returns true if it is valid.
    */
    static Boolean isValidHostName(const String &hostName);

    /**
        The covertBinaryToText (inet_ntop()) function shall convert a numeric
        address into a text string suitable for presentation. The af argument
        shall specify the family of the address. This can be AF_INET  or 
        AF_INET6. The src argument points to a buffer  holding  an IPv4 address
        if the af argument is AF_INET,  or an IPv6 address if the af argument is
        AF_INET6. The address must be in network byte order. The dst argument
        points to a buffer  where  the  function  stores  the resulting  text
        string. It shall not be NULL. The size argument specifies the size of
        this buffer, which shall be  large enough to hold the text string 
        (PEGASUS_INET_ADDRSTR_LEN  characters  for  IPv4, 
        PEGASUS_INET6_ADDRSTR_LEN  characters  for IPv6).
    */
    static const char *convertBinaryToText(int af, const void *src,
        char *dst, Uint32 size);

    /*
        The  convertTextToBinray (inet_pton())  function  shall convert an
        address in its standard text presentation form into its numeric
        binary form.  The af argument  shall specify the family
        of the address. The AF_INET and AF_INET6 address families
        shall be supported. The src argument points to the
        string being passed in. The dst argument points to a buffer into which
        the function stores the numeric address. This shall be large enough to
        hold  the  numeric  address  (32  bits  for  AF_INET,  128 bits for
        AF_INET6).
    */
    static int convertTextToBinary(int af, const char *src, void *dst);

    /**
        Checks whether the two addresses in binary form are equal based on
        address family. af can be AF_INET or AF_INET6.
    */
    static Boolean equal(int af, void *p1, void *p2);

    /**
        Returns HostName or IPv4Address or IPv6Address. Removes port number
        from HostAddress if present. This returns empty string HostAddress is
        not valid. Check if HostAddress is valid by using isValid() method
        before making any calls on HostAddress object.
    */
    String getHost();

    /**
        Returns port number assosiated with this HostAddress.
    */
    Uint32 getPort();

    /**
        Returns port number in the string form.
    */
    String getPortString();

    /*
        Returns true if port is specified as part of HostAddress and it is
        valid.
    */
    Boolean isPortSpecified ();

    /**
       Returns address type. It can be AT_IPV4, AT_IPV6 or AT_HOSTNAME.
    */
    Uint32 getAddressType();

private:
    void _init();
    void _parseAddress();
    String _hostAddrStr;
    String _hostAddress;
    Uint32 _portNumber;
    Uint16 _addrType;
    Boolean _isValid;
};

PEGASUS_NAMESPACE_END

#endif //Pegasus_HostAddress_h