odnetworkaccess.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Salil Agarwal
 Date:          Oct 2012
________________________________________________________________________

-*/

#include "networkmod.h"
#include "bufstringset.h"
#include "executor.h"
#include "uistring.h"
#include "ptrman.h"

class QByteArray;
class QEventLoop;
class QFile;
class QNetworkAccessManager;
class ODNetworkProcess;
class DataBuffer;
class od_ostream;

namespace Network
{
    class HttpRequestProcess;

    mGlobal(Network) bool   downloadFile(const char* url,const char* outpath,
                                         uiString& errmsg,TaskRunner* taskr=0);

    mGlobal(Network) bool   downloadFiles(BufferStringSet& urls,
                                          const char* outpath,
                                          uiString& errmsg,
                                          TaskRunner* taskr=0);

    mGlobal(Network) bool   downloadFiles(BufferStringSet& urls,
                                          BufferStringSet& outpaths,
                                          uiString& errmsg,
                                          TaskRunner* taskr=0);

    mGlobal(Network) bool   downloadToBuffer(const char* url,DataBuffer&,
                                             uiString& errmsg,
                                             TaskRunner* taskr=0);

    mGlobal(Network) bool   uploadFile(const char* url,const char* localfname,
                                       const char* remotefname,
                                       const char* ftype,const IOPar& postvars,
                                       uiString& errmsg,TaskRunner* taskr=0,
                                       uiString* returnedmessage = 0);

    mGlobal(Network) bool   uploadQuery(const char* url,const IOPar& querypars,
                                        uiString& errmsg,TaskRunner* taskr=0,
                                        uiString* returnedmessage = 0);

    mGlobal(Network) bool   getRemoteFileSize(const char* url,od_int64& size,
                                              uiString& errmsg);

    mGlobal(Network) bool   ping(const char* url, uiString& msg );

    mGlobal(Network) void   setHttpProxy(const char* hostname,int port,
                                         bool auth=false,
                                         const char* username=0,
                                         const char* password=0);

    mGlobal(Network) void   setHttpProxyFromSettings();
    mGlobal(Network) void   setHttpProxyFromIOPar(const IOPar&);
    mGlobal(Network) bool   getProxySettingsFromUser();

    inline const char*      sKeyUseProxy()  { return "Use Proxy"; }
    inline const char*      sKeyUseAuthentication()
                                            { return "Use Authentication";}
    inline const char*      sKeyProxyHost()
                                            { return "Http Proxy Host"; }
    inline const char*      sKeyProxyPort()
                                            { return "Http Proxy Port"; }
    inline const char*      sKeyProxyUserName()
                                            { return "Http Proxy User Name"; }
    inline const char*      sKeyProxyPassword()
                                            { return "Http Proxy Password"; }
    inline const char*      sKeyCryptProxyPassword()
                                        { return "Http Crypt Proxy Password"; }

                                // File:: counterparts
    mGlobal(Network) bool       exists(const char*);
    mGlobal(Network) od_int64   getFileSize(const char*);
    mGlobal(Network) bool       getContent(const char*,BufferString&);

}

mExpClass(Network) FileDownloader : public SequentialTask
{ mODTextTranslationClass(FileDownloader);
public:
                        FileDownloader(const char* url);
                        FileDownloader(const char* url,DataBuffer& db);
                        FileDownloader(const BufferStringSet& urls,
                                       const BufferStringSet& outputpaths);
                        ~FileDownloader();

    od_int64            getDownloadSize();

    uiString            message() const;
    int                 nextStep();
    od_int64            nrDone() const;
    uiString            nrDoneText() const;
    od_int64            totalNr() const;

protected:

    void                setSaveAsPaths(const BufferStringSet&,const char*);
    int                 errorOccured();

    bool                writeData();
    bool                writeDataToFile(const char* buffer, int size);
    bool                writeDataToBuffer(const char* buffer, int size);

    bool                                initneeded_;
    BufferStringSet                     urls_;
    BufferStringSet                     saveaspaths_;
    int                                 nrfilesdownloaded_;
    DataBuffer*                         databuffer_;
    od_ostream*                         osd_;

    RefMan<Network::HttpRequestProcess> odnr_;

    od_int64                            nrdone_;
    od_int64                            totalnr_;
    uiString                            msg_;
};


mExpClass(Network) DataUploader : public SequentialTask
{ mODTextTranslationClass(DataUploader);
public:
                        DataUploader(const char* url,const DataBuffer& data,
                                     BufferString& header);
                        ~DataUploader();

    uiString            message() const;
    int                 nextStep();
    od_int64            nrDone() const;
    uiString            nrDoneText() const;
    od_int64            totalNr() const;

protected:

    int                                 errorOccured();

    bool                                init_;
    BufferString                        url_;
    BufferString                        header_;

    const DataBuffer&                   data_;
    RefMan<Network::HttpRequestProcess> odnr_;

    od_int64                            nrdone_;
    od_int64                            totalnr_;
    uiString                            msg_;
};


mExpClass(Network) NetworkUserQuery
{
public:
    virtual bool        setFromUser()           = 0;

    static void                 setNetworkUserQuery(NetworkUserQuery*);
    static NetworkUserQuery*    getNetworkUserQuery();
protected:

    static NetworkUserQuery*    inst_;
};