kicad_curl_easy.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Mark Roszko <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
#ifndef KICAD_CURL_EASY_H_
#define KICAD_CURL_EASY_H_
 
/*
 * curl.h, and therefore kicad_curl.h must be included before wxWidgets headers because on Windows,
 * wxWidgets ends up including windows.h before winsocks2.h
 * curl and curl.h causes build warnings if included before any wxxxx.h
 *
 * So kicad_curl_easy.h does not include curl.h to avoid constraints,
 * and including kicad_curl.h could be needed in a few sources
 */
 
#include <kicommon.h>
#include <functional>
#include <memory>
#include <ostream>
#include <string>
#include <cstdint>
#include <shared_mutex>
 
typedef void CURL;
struct curl_slist;

 
 
typedef std::function<int( size_t, size_t, size_t, size_t )> TRANSFER_CALLBACK;
struct CURL_PROGRESS;
 
 
class KICOMMON_API KICAD_CURL_EASY
{
public:
    KICAD_CURL_EASY();
    ~KICAD_CURL_EASY();

    int Perform();

    void SetHeader( const std::string& aName, const std::string& aValue );

    bool SetUserAgent( const std::string& aAgent );

    bool SetPostFields( const std::vector<std::pair<std::string, std::string>>& aFields );

    bool SetPostFields( const std::string& aField );

    bool SetURL( const std::string& aURL );

    bool SetFollowRedirects( bool aFollow );

    const std::string GetErrorText( int aCode );
 
    int GetTransferTotal( uint64_t& aDownloadedBytes ) const;

    const std::string& GetBuffer() { return m_buffer; }

    std::string Escape( const std::string& aUrl );
 
    bool SetTransferCallback( const TRANSFER_CALLBACK& aCallback, size_t aInterval );
 
    bool SetOutputStream( const std::ostream* aOutput );

    bool SetConnectTimeout( long aTimeoutSecs );

    bool SetTimeout( long aTimeoutSecs );

    bool SetStallTimeout( long aMinBytesPerSec, long aDurationSecs );
 
    CURL* GetCurl() { return m_CURL; }
 
    int GetResponseStatusCode();
 
private:
    template <typename T>
    int setOption( int aOption, T aArg );
 
    CURL*                               m_CURL;
    curl_slist*                         m_headers;
    std::string                         m_buffer;
    std::unique_ptr<CURL_PROGRESS>      progress;
    std::shared_lock<std::shared_mutex> m_curlSharedLock;
};
 
 
#endif // KICAD_CURL_EASY_H_