MRWebRequest.h

Go to the documentation of this file.

#pragma once
#include "MRMesh/MRMeshFwd.h"
#if defined( __EMSCRIPTEN__ ) || !defined( MRMESH_NO_CPR )
#include "MRWebResponseCallback.h"
#include "MRMesh/MRExpected.h"
#include <unordered_map>
#include <string>
#include <functional>
#include <filesystem>
 
namespace MR
{
// returns json value of text or error if response failed
MRVIEWER_API Expected<Json::Value> parseResponse( const Json::Value& response );
 
// this class is needed to unify cpp and wasm requests
class MRVIEWER_CLASS WebRequest
{
public:
    WebRequest() = default;
    MRVIEWER_API explicit WebRequest( std::string url );
 
    enum class Method 
    {
        Get,
        Post,
        Patch,
        Put,
        Delete,
    };
 
    // clear all request data
    MRVIEWER_API void clear();
 
    // set HTTP method
    MRVIEWER_API void setMethod( Method method );
 
    // set timeout in milliseconds
    MRVIEWER_API void setTimeout( int timeoutMs );
 
    // set URL query parameters
    MRVIEWER_API void setParameters( std::unordered_map<std::string, std::string> parameters );
 
    // set HTTP headers
    MRVIEWER_API void setHeaders( std::unordered_map<std::string, std::string> headers );
 
    // set path to the file to upload
    MRVIEWER_API void setInputPath( std::filesystem::path inputPath );
 
    // set progress callback for upload
    // NOTE: due to limitations, the upload callback won't work on web platforms when `setOutputPath` method is called
    MRVIEWER_API void setUploadProgressCallback( ProgressCallback callback );
 
    // set payload in multipart/form-data format
    struct FormData
    {
        std::string path;
        std::string contentType;
        std::string name;
        std::string fileName;
    };
    MRVIEWER_API void setFormData( std::vector<FormData> formData );
 
    // set payload in plain format
    MRVIEWER_API void setBody( std::string body );
 
    // prefer to save the response to file
    MRVIEWER_API void setOutputPath( std::filesystem::path outputPath );
 
    // set progress callback for download
    MRVIEWER_API void setDownloadProgressCallback( ProgressCallback callback );
 
    // set async mode (return immediately after sending request)
    MRVIEWER_API void setAsync( bool async );
 
    // set log name
    MRVIEWER_API void setLogName( std::string logName );
 
    using ResponseCallback = MR::WebResponseCallback;
 
    MRVIEWER_API void send( std::string url, std::string logName, ResponseCallback callback, bool async = true );
    MRVIEWER_API void send( ResponseCallback callback );
 
    MRVIEWER_API static void waitRemainingAsync();
 
private:
    Method method_{ Method::Get };
    std::string url_;
    std::string logName_;
    bool async_{ true };
    int timeout_{ 10000 };
    std::unordered_map<std::string, std::string> params_;
    std::unordered_map<std::string, std::string> headers_;
    std::filesystem::path inputPath_;
    std::vector<FormData> formData_;
    std::string body_;
    std::filesystem::path outputPath_;
    ProgressCallback uploadCallback_;
    ProgressCallback downloadCallback_;
};
 
}
#endif