url.h

Go to the documentation of this file.

// Copyright (C) 2001-2002 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 to the GNU General Public License, permission is 
// granted for additional uses of the text contained in its release 
// of Common C++.
// 
// The exception is that, if you link the Common C++ library with other files
// to produce an executable, this does not by itself cause the
// resulting executable to be covered by the GNU General Public License.
// Your use of that executable is in no way restricted on account of
// linking the Common C++ library code into it.
//
// 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 Common C++.  If you copy code from other releases into a copy of
// 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 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_URLSTRING_H_
#include <cc++/urlstring.h>
#endif

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class CCXX_CLASS_EXPORT URLStream;

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

        typedef enum
        {
                authAnonymous = 0,
                authBasic
        } Authentication;

        typedef enum
        {
                encodingBinary = 0,
                encodingChunked
        } Encoding;

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

        typedef enum
        {
                protocolHttp1_0,
                protocolHttp1_1
        } Protocol;

private:
        const char *agent, *referer, *cookie, *pragma, *user, *password;
        const char *localif;
        InetHostAddress proxyHost;
        tpport_t proxyPort;
        Method urlmethod;
        Encoding encoding;
        Protocol protocol;
        Authentication auth;
        timeout_t timeout;
        bool persistent;
        bool follow;
        unsigned chunk;

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

protected:
        Error sendHTTPHeader(const char *url, const char **vars, int bufsize);
        int underflow(void);

        virtual int aRead(char *buffer, size_t len, timeout_t timeout)
#ifndef __MINGW32__
                {return ::read(so, buffer, len);};
#else
                {return ::recv(so, buffer, len, 0); };
#endif

        virtual int aWrite(char *buffer, size_t len, timeout_t timeout)
#ifndef __MINGW32__
                {return ::write(so, buffer, len);};
#else
                {return ::send(so, buffer, len, 0); };
#endif

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

        virtual char **extraHeader(void)
                {return NULL;};

public:
        URLStream(timeout_t to = 0);

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

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

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

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

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

        void close();

        void setReferer(const char *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 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;} 
};

#ifdef  CCXX_NAMESPACES
};
#endif

#endif

---