Uri.hpp

// 
// BEGIN_DOUGLAS_MARK_ROYER_COPYRIGHT
// 
// Copyright (C) 1993-2015 Douglas Mark Royer, All Rights Reserved.
// 
// NOTICE:
// 
// THIS SOURCE CODE BELONGS TO DOUGLAS MARK ROYER
// CORPORATION, A NEVADA CORPORATION.  THIS CODE IS PROPERTY
// OF THE COPYRIGHT HOLDER AND IS NOT TO BE DIVULGED OR USED BY
// PARTIES WHO HAVE NOT RECEIVED WRITTEN AUTHORIZATION FROM THE OWNER.
// 
// THIS SOFTWARE AND MANUAL ARE BOTH PROTECTED BY UNITED STATES
// COPYRIGHT LAW (TITLE 17 UNITED STATES CODE). UNAUTHORIZED REPRODUCTION
// AND/OR SALE MAY RESULT IN IMPRISONMENT OF UP TO ONE YEAR AND FINES
// OF UP TO $100,000 (17 USC 506). COPYRIGHT INFRINGERS MAY ALSO
// BE SUBJECT TO CIVIL LIABILITY.
// 
// THIS NOTICE AND THE ABOVE COPYRIGHT NOTICE MUST REMAIN IN ALL
// COPIES AND ANY DERIVED WORK.
// 
// ALL OF THIS CODE IS ORIGINAL WORK BY THE COPYRIGHT HOLDER.
// 
// THIS  DOCUMENT  AND  THE  INFORMATION  CONTAINED  HEREIN  IS
// PROVIDED  ON  AN "AS IS" BASIS AND INET-CONSULTING.COM, INC.
// DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,  INCLUDING  BUT
// NOT  LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
// HEREIN  WILL  NOT  INFRINGE  ANY  RIGHTS  OR   ANY   IMPLIED
// WARRANTIES  OF  MERCHANTABILITY  OR FITNESS FOR A PARTICULAR
// PURPOSE.  ANY SERVICE CONTRACT  WILL  BE  UNDER  A  SEPARATE
// LICENSE.
// 
// END_DOUGLAS_MARK_ROYER_COPYRIGHT
//

#ifndef PROJECT_CONTRACTING_LIBRARY_RFCBASIC_URI_HPP
#define PROJECT_CONTRACTING_LIBRARY_RFCBASIC_URI_HPP

#ifndef EXPORT_RFC
#ifdef BUILDING_LIBRARY_RFC
#define EXPORT_RFC EXPORT_OUT
#else
#define EXPORT_RFC EXPORT_IN
#endif
#endif

#ifdef WIN32
#pragma warning (disable : 4251)
#endif

#ifdef BUILDING_LIBRARY_RFC
#include "rfcTokens.h"
#else
#include <SaS/RfcBasic/rfcTokens.h>
#endif

#include <SaS/Common/Base.hpp>
#include <SaS/Common/String.hpp>
#include <SaS/Common/StringCache.hpp>

#include <sys/types.h>
#include <string>
#include <map>

using namespace std;
using namespace SoftwareAndServices::Library::Common;

namespace SoftwareAndServices
{
  namespace Library
  {
    namespace RfcBasic
    {

      class EXPORT_RFC Uri
    : public instance<Uri>
      {

      public:
                
    static const char   *   URICap_s;
    static const char   *   URICid_s;
    static const char   *   URIFile_s;
    static const char   *   URIFtp_s;
    static const char   *   URIGopher_s;
    static const char   *   URIHttp_s;
    static const char   *   URIHttps_s;
    static const char   *   URILdap_s;
    static const char   *   URIMailTo_s;
    static const char   *   URIMid_s;
    static const char   *   URINews_s;
    static const char   *   URINntp_s;
    static const char   *   URIProsperp_s;
    static const char   *   URITelnet_s;
    static const char   *   URIWais_s;
    static const char   *   URIWebCal_s;
    static const char   *   URIWebDav_s;
    static const char   *   URICalDav_s;
    static const char   *   URISql_s;
    static const char   *   URILotusCal_s;
    static const char   *   URIMicrosoftCal_s;
    static const char   *   URIOracleCal_s;
    static const char   *   URISip_s;
    static const char   *   URISips_s;

    class EXPORT_RFC NameValuePair
    {

    public:

      NameValuePair();

      NameValuePair(const char * TheName, const char * TheValue);

      virtual ~NameValuePair();

      const char    *   Name() const;

      const char    *   Value() const;

    private:

      const char    *   _Name;

      const char    *   _Value;
    };

    class EXPORT_RFC Parameter
      : public NameValuePair
    {
    public:

      Parameter(const char * TheName, const char * TheValue);
    };

    class EXPORT_RFC Header
      : public NameValuePair
    {
    public:

      Header(const char * TheName, const char * TheValue);
    };

    enum Uri_t {
      Other_t,

      Cap_t,

      Cid_t,

      File_t,

      Ftp_t,

      Gopher_t,

      Http_t,

      Https_t,

      Ldap_t,

      MailTo_t,

      Mid_t,

      News_t, 

      Nntp_t,

      Prosperp_t,

      Telnet_t,

      Wais_t,

      WebCal_t,

      WebDav_t,

      CalDav_t,

      Sql_t,

      LotusCal_t,

      MicrosoftCal_t,

      OracleCal_t,

      Sip_t,

      Sips_t,

      URI_LAST
    };

    Uri();

    virtual ~Uri();

    Uri_t           GetSchemeType() const;

    const char  *   GetScheme() const;

    const char  *   GetSchemeSpecific() const;

    const char  *   GetServer() const;

    short           GetPort() const;

    const char  *   GetUser() const;

    const char  *   GetPassword() const;

    void            SetSchemeType(const Uri_t type,
                          const char * otherType = NULL);

    void            SetScheme(const char * type);

    void            SetSchemeSpecific(const char * value);

    void            SetServer(const char * server);

    void            SetPort(const int port);

    void            SetUser(const char * user);

    void            SetPassword(const char * pw);

    bool            IsUri(const char * IsSuppotedUri) const;

    bool            Parse(const char * aString);

    virtual bool        Sprint(string * Results) const;

    virtual bool        Sprint(String & Results) const;

    bool            Sprint(char * resultString,
                       const size_t resultStringMaxSize) const;

    const char  *   GetUri() const;

    bool            operator==(const Uri * Other) const;

    bool            operator!=(const Uri * Other) const;

    bool            operator==(const Uri & Other) const;

    bool            operator!=(const Uri & Other) const;

    bool            operator==(const char * Other) const;

    bool            operator!=(const char * Other) const;

    void            AddParameter(const char * TheName,
                         const char * TheValue);

    void        AddHeader(const char * TheName,
                  const char * TheValue);

    size_t      ParameterCount() const;

    size_t      HeaderCount() const;

    const Parameter *   GetParameter(unsigned long nTh) const;

    const Header    *   GetHeader(unsigned long nTh) const;

    const Parameter *   GetParameter(const char * TheName) const;

    const Header    *   GetHeader(const char * TheName) const;

    static const char   *   UriTokenTable[40];

      private:
    Uri_t               _uriType;

    mutable const char  *   _scheme;
    mutable const char  *   _schemeSpecific;

    const char      *   _server;
    int             _port;
    const char      *   _user;
    const char      *   _password;

    std::map<const char*,Parameter*>    _Parameters;
    std::map<const char*,Header*>       _Headers;

    // Cached - hence mutable
    //
    mutable const char  *   _fullUri;
      };

    }
  }
}

#endif //PROJECT_CONTRACTING_LIBRARY_RFCBASIC_URI_HPP