url.h

Go to the documentation of this file.

// Copyright (C) 2001-2005 Open Source Telecom Corporation.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// Common C++.  If you copy code from other releases into a copy of GNU
// Common C++, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU Common C++, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_URL_H_
#define CCXX_URL_H_

#ifndef CCXX_CONFIG_H_
#include <cc++/config.h>
#endif

#ifndef CCXX_SOCKET_H_
#include <cc++/socket.h>
#endif

#ifndef CCXX_MIME_H_
#include <cc++/mime.h>
#endif

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class __EXPORT URLStream : public TCPStream
{
public:
        typedef enum {
                errSuccess = 0,
                errUnreachable,
                errMissing,
                errDenied,
                errInvalid,
                errForbidden,
                errUnauthorized,
                errRelocated,
                errFailure,
                errTimeout,
                errInterface
        } Error;

        typedef enum {
                authAnonymous = 0,
                authBasic
        } Authentication;

        typedef enum {
                encodingBinary = 0,
                encodingChunked
        } Encoding;

        typedef enum {
                methodHttpGet,
                methodHttpPut,
                methodHttpPost,
                methodHttpPostMultipart,
                methodFtpGet,
                methodFtpPut,
                methodFileGet,
                methodFilePut
        } Method;

        typedef enum {
                protocolHttp1_0,
                protocolHttp1_1
        } Protocol;

private:
        const char *agent, *referer, *cookie, *pragma, *user, *password;
        const char *proxyUser, *proxyPasswd;
        const char *localif;
        IPV4Host proxyHost;
#ifdef  CCXX_IPV6
        IPV6Host v6proxyHost;
#endif
        tpport_t proxyPort;
        Method urlmethod;
        Encoding encoding;
        Protocol protocol;
        Authentication auth;
        Authentication proxyAuth;
        timeout_t timeout;
        bool persistent;
        bool follow;
        unsigned chunk;

        Error getHTTPHeaders();
        URLStream(const URLStream& rhs);

protected:
        ost::String m_host, m_address;

        Error sendHTTPHeader(const char *url, const char **vars, size_t bufsize);

        int underflow(void);

        virtual int aRead(char *buffer, size_t len, timeout_t timer);

        virtual int aWrite(char *buffer, size_t len, timeout_t timer);

        virtual void httpHeader(const char *header, const char *value);

        virtual char **extraHeader(void);

public:
        URLStream(Family family = IPV4, timeout_t timer = 0);

        URLStream &getline(char *buffer, size_t len);

        Error get(const char *url, size_t buffer = 512);

        Error get(size_t buffer = 512);

        Error submit(const char *url, const char **vars, size_t buffer = 512);

        Error post(const char *url, const char **vars, size_t buffer = 512);

        Error post(const char *url, MIMEMultipartForm &form, size_t buffer = 512);

        Error head(const char *url, size_t buffer = 512);

        void close();

        void setReferer(const char *str);

        inline void setHost(const char *str)
                {m_host = str;};

        inline void setAddress(const char *str)
                {m_address = str;};

        inline void setCookie(const char *str)
                {cookie = str;};

        inline void setUser(const char *str)
                {user = str;};

        inline void setPassword(const char *str)
                {password = str;};

        void setAuthentication(Authentication a, const char *str = NULL);

        inline void setProxyUser(const char *str)
                {proxyUser = str;};

        inline void setProxyPassword(const char *str)
                {proxyPasswd = str;};

        void setProxyAuthentication(Authentication a, const char *str = NULL);

        inline void setPragma(const char *str)
                {pragma = str;};

        void setProxy(const char *host, tpport_t port);

        inline void setAgent(const char *str)
                {agent = str;};

        inline Method getMethod(void)
                {return urlmethod;};

        inline void setTimeout(timeout_t to)
                {timeout = to;};

        inline void setFollow(bool enable)
                {follow = enable;};

        inline void setProtocol(Protocol pro)
                {protocol = pro;};
        inline void setLocalInterface(const char *intf)
        {localif=intf;}
};

__EXPORT char* urlDecode(char *source, char *dest = NULL);

__EXPORT char* urlEncode(const char *source, char *dest, size_t size);

__EXPORT char* b64Decode(char *src, char *dest = NULL);

__EXPORT char* b64Encode(const char *source, char *dest, size_t size);

__EXPORT size_t b64Encode(const unsigned char *src, size_t srcsize,
               char *dst, size_t dstsize);

__EXPORT size_t b64Decode(const char *src,
                unsigned char *dst, size_t dstsize);

__EXPORT String b64Encode(const String& src);

__EXPORT String b64Decode(const String& src);

__EXPORT String b64Encode(const unsigned char *src, size_t srcsize);

__EXPORT size_t b64Decode(const String& src,
                unsigned char *dst, size_t dstsize);


#ifdef  CCXX_NAMESPACES
}
#endif

#endif