curl_wrapper.hpp

/*  This file is part of mastodonpp.
 *  Copyright © 2020 tastytea <tastytea@tastytea.de>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published by
 *  the Free Software Foundation, version 3.
 *
 *  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 Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef MASTODONPP_CURL_WRAPPER_HPP
#define MASTODONPP_CURL_WRAPPER_HPP
 
#include "curl/curl.h"
#include "types.hpp"
 
#include <mutex>
#include <string>
#include <string_view>
 
namespace mastodonpp
{
 
using std::mutex;
using std::string;
using std::string_view;
 
enum class http_method
{
    GET,   // NOLINT(readability-identifier-naming)
    POST,  // NOLINT(readability-identifier-naming)
    PATCH, // NOLINT(readability-identifier-naming)
    PUT,   // NOLINT(readability-identifier-naming)
    DELETE // NOLINT(readability-identifier-naming)
};
 
class CURLWrapper
{
public:
    CURLWrapper();
 
    CURLWrapper(const CURLWrapper &);
 
    CURLWrapper(CURLWrapper &&other) noexcept = delete;
 
    virtual ~CURLWrapper() noexcept;
 
    CURLWrapper &operator=(const CURLWrapper &other) = delete;
 
    CURLWrapper &operator=(CURLWrapper &&other) noexcept = delete;
 
    inline CURL *get_curl_easy_handle()
    {
        return _connection;
    }
 
    [[nodiscard]] inline string escape_url(const string_view url) const
    {
        char *cbuf{curl_easy_escape(_connection, url.data(),
                                    static_cast<int>(url.size()))};
        string sbuf{cbuf};
        curl_free(cbuf);
        return sbuf;
    }
 
    [[nodiscard]] inline string unescape_url(const string_view url) const
    {
        char *cbuf{curl_easy_unescape(_connection, url.data(),
                                      static_cast<int>(url.size()), nullptr)};
        string sbuf{cbuf};
        curl_free(cbuf);
        return sbuf;
    }
 
    void setup_connection_properties(string_view proxy,
                                     string_view access_token,
                                     string_view cainfo, string_view useragent);
 
protected:
    mutex _buffer_mutex;
 
    [[nodiscard]] answer_type make_request(const http_method &method,
                                           string uri,
                                           const parametermap &parameters);
 
    [[nodiscard]] inline string &get_buffer()
    {
        return _curl_buffer_body;
    }
 
    inline void cancel_stream()
    {
        _stream_cancelled = true;
    }
 
    virtual void set_proxy(string_view proxy);
 
    void set_access_token(string_view access_token);
 
    virtual void set_cainfo(string_view path);
 
    virtual void set_useragent(string_view useragent);
 
private:
    CURL *_connection{nullptr};
    char _curl_buffer_error[CURL_ERROR_SIZE]{'\0'};
    string _curl_buffer_headers;
    string _curl_buffer_body;
    bool _stream_cancelled{false};
 
    void init();
 
    size_t writer_body(char *data, size_t size, size_t nmemb);
 
    static inline size_t writer_body_wrapper(char *data, size_t sz,
                                             size_t nmemb, void *f)
    {
        return static_cast<CURLWrapper *>(f)->writer_body(data, sz, nmemb);
    }
 
    size_t writer_header(char *data, size_t size, size_t nmemb);
 
    static inline size_t writer_header_wrapper(char *data, size_t sz,
                                               size_t nmemb, void *f)
    {
        return static_cast<CURLWrapper *>(f)->writer_header(data, sz, nmemb);
    }
 
    int progress(void *clientp, curl_off_t dltotal, curl_off_t dlnow,
                 curl_off_t ultotal, curl_off_t ulnow) const;
 
    static inline int progress_wrapper(void *f, void *clientp,
                                       curl_off_t dltotal, curl_off_t dlnow,
                                       curl_off_t ultotal, curl_off_t ulnow)
    {
        return static_cast<CURLWrapper *>(f)->progress(clientp, dltotal, dlnow,
                                                       ultotal, ulnow);
    }
 
    void setup_curl();
 
    static bool replace_parameter_in_uri(string &uri,
                                         const parameterpair &parameter);
 
    static void add_parameters_to_uri(string &uri,
                                      const parametermap &parameters);
 
    static void add_mime_part(curl_mime *mime, string_view name,
                              string_view data);
 
    curl_mime *parameters_to_curl_mime(string &uri,
                                       const parametermap &parameters);
};
 
} // namespace mastodonpp
 
#endif // MASTODONPP_CURL_WRAPPER_HPP