Utility.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------------
//
// Pro-Vocation Light Engine (PVLE)
// Copyright (C) 2007-2009  Sukender, KinoX & Buzib
// For more information, contact us : sukender@free.fr
//
// 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 3 of the License, or
// (at your option) any later version.
//
// For any use that is not compatible with the terms of the GNU 
// General Public License, please contact the authors for alternative
// licensing options.
//
// 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.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//-----------------------------------------------------------------------------------

#ifndef NET_HTTP_UTILITY_H
#define NET_HTTP_UTILITY_H

#include <PVLE/Config.h>

#ifdef PVLE_URL

#include <string>
#include <curl/curl.h>
#include <PVLE/Util/Singleton.h>
#include <PVLE/Util/Util.h>
#include <PVLE/Export.h>

//class CURL;
typedef void CURL;      // Definition of curl.h

namespace Net {

class PVLE_EXPORT CURLHolder : public Util::Singleton<CURLHolder> {
public:
    CURLHolder();
    virtual ~CURLHolder();

    const CURL * getHandle() const { return handle; }
    CURL * getHandle() { return handle; }
    operator CURL *() const { return handle; }
    operator CURL *() { return handle; }

protected:
    CURL * handle;
};


class URLOptions {
public:
    enum EProxyType {
        PROXY_HTTP = CURLPROXY_HTTP,
        PROXY_SOCKS4 = CURLPROXY_SOCKS4,
        PROXY_SOCKS5 = CURLPROXY_SOCKS5,
        PROXY_SOCKS4A = CURLPROXY_SOCKS4A,
        PROXY_SOCKS5_HOSTNAME = CURLPROXY_SOCKS5_HOSTNAME
    };

    URLOptions(std::string proxyAddress = "", UINT proxyPort = 8080, EProxyType proxyType = PROXY_HTTP)
        : proxyAddress(proxyAddress), proxyPort(proxyPort), proxyType(), timeout(15)
    {}


    bool usesProxy() const { return !proxyAddress.empty() && proxyPort!=0; }
    const std::string & getProxyAddress() const { return proxyAddress; }
    void setProxyAddress(const std::string & address) { proxyAddress = address; }
    UINT getProxyPort() const { return proxyPort; }
    void setProxyPort(UINT port) { proxyPort = port; }
    EProxyType getProxyType() const { return proxyType; }
    void setProxyType(EProxyType type) { proxyType = type; }
    PVLE_EXPORT void setProxyType(std::string strType);     // Argument by copy

    UINT getTimeout() const { return timeout; }
    void setTimeout(UINT time) { timeout = time; }

protected:
    std::string proxyAddress;
    UINT proxyPort;
    EProxyType proxyType;
    UINT timeout;       
};


PVLE_EXPORT void applyOptions(const URLOptions & options);


PVLE_EXPORT std::string readURLAsString(const std::string & url, const URLOptions & options = URLOptions());


}  // namespace Net

#endif  // PVLE_URL

#endif  // NET_CONVERTERS_H

---