UrlUtils.hpp

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                     _     _   _   _     __     _                     |
|                    | |   | | | \_/ |   /  \   | |                    |
|                    | |   | | | |_| |  / /\ \  | |                    |
|                    | |__ | | | | | | / ____ \ | |__                  |
|                    |____||_| |_| |_|/ /    \ \|____|                 |
|                                                                      |
|                             core library                             |
|                                                                      |
|                                         (C) SUSE Linux Products GmbH |
\----------------------------------------------------------------------/

  File:       UrlUtils.hpp

  Author:     Marius Tomaschewski
  Maintainer: Marius Tomaschewski

/-*/
#ifndef   LIMAL_URLUTILS_HPP
#define   LIMAL_URLUTILS_HPP

#include <limal/config.h>
#include <limal/ByteBuffer.hpp>
#include "blocxx/Exception.hpp"
#include <blocxx/String.hpp>
#include <blocxx/Array.hpp>
#include <blocxx/Map.hpp>


// -------------------------------------------------------------------
namespace LIMAL_NAMESPACE
{
namespace url
{

// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION (Url);


// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION2(UrlParsing,      UrlException);


// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION2(UrlDecoding,     UrlException);


// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION2(UrlBadComponent, UrlException);


// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION2(UrlNotAllowed,   UrlException);


// -------------------------------------------------------------------
BLOCXX_DECLARE_EXCEPTION2(UrlNotSupported, UrlException);


// -------------------------------------------------------------------
typedef blocxx::Map<blocxx::String,blocxx::String>      ParamMap;


// -------------------------------------------------------------------
struct UrlComponents
{
        blocxx::String  scheme;
        blocxx::String  authority;
        blocxx::String  pathdata;
        blocxx::String  querystr;
        blocxx::String  fragment;
        bool            has_scheme;
        bool            has_authority;
        bool            has_querystr;
        bool            has_fragment;
};


// -------------------------------------------------------------------
struct UrlAuthority
{
        blocxx::String  user;
        blocxx::String  pass;
        blocxx::String  host;
        blocxx::String  port;
        bool            has_user;
        bool            has_pass;
        bool            has_port;
};


// -------------------------------------------------------------------
typedef enum {
    E_ENCODED, 
    E_DECODED  
} EEncoding;


// -------------------------------------------------------------------
blocxx::String
encode(const blocxx::String    &str,
       const blocxx::String    &safe = "",
       limal::url::EEncoding   eflag = E_DECODED);


// -------------------------------------------------------------------
blocxx::String
encode_buf(const limal::ByteBuffer &buf,
           const blocxx::String    &safe = "",
           limal::url::EEncoding   eflag = E_DECODED);


// -------------------------------------------------------------------
blocxx::String
decode(const blocxx::String &str);


// -------------------------------------------------------------------
limal::ByteBuffer
decode_buf(const blocxx::String &str, bool allowNUL);


// -------------------------------------------------------------------
blocxx::String
encode_octet(const unsigned char c);


// -------------------------------------------------------------------
int
decode_octet(const char *hex);


// -------------------------------------------------------------------
blocxx::StringArray
split(const blocxx::String &pstr,
      const blocxx::String &psep);


// -------------------------------------------------------------------
limal::url::ParamMap
split(const blocxx::String &pstr,
      const blocxx::String &psep,
      const blocxx::String &vsep,
      EEncoding            eflag = E_ENCODED);


// -------------------------------------------------------------------
blocxx::String
join(const blocxx::StringArray &parr,
     const blocxx::String      &psep);


// -------------------------------------------------------------------
blocxx::String
join(const limal::url::ParamMap &pmap,
     const blocxx::String       &psep,
     const blocxx::String       &vsep,
     const blocxx::String       &safe);


// -------------------------------------------------------------------
/*
 * Parse the @p url string by common URL separator characters
 * and return an url main component structure.
 * @returns An url components structure.
 */
UrlComponents
parse_url_string(const blocxx::String &url);


// -------------------------------------------------------------------
/*
 * Parse the @p authority string and return the URL authority
 * components structure.
 * @returns An string array containing authority components.
 */
UrlAuthority
parse_url_authority(const blocxx::String &authority);


// -------------------------------------------------------------------
}      // End url namespace
}      // End of LIMAL_NAMESPACE
#endif // LIMAL_URLUTILS_HPP
// vim: set ts=8 sts=8 sw=8 ai noet: