CurlWrapper.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDKASSETSCOMMON_CURLWRAPPER_H_
#define ACSDKASSETSCOMMON_CURLWRAPPER_H_

#include <AVSCommon/SDKInterfaces/AuthDelegateInterface.h>
#include <AVSCommon/Utils/Error/Result.h>
#include <curl/curl.h>

#include <atomic>
#include <memory>
#include <ostream>
#include <regex>
#include <string>

#include "DownloadChunkQueue.h"
#include "DownloadStream.h"
#include "ResponseSink.h"
#include "acsdkAssetsCommon/CurlProgressCallbackInterface.h"
#include "acsdkAssetsInterfaces/ResultCode.h"

namespace alexaClientSDK {
namespace acsdkAssets {
namespace common {

class CurlWrapper {
public:
    // Destructor takes care of freeing the CURL handle
    virtual ~CurlWrapper();

    static std::unique_ptr<CurlWrapper> create(
            bool isThrottled,
            std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate,
            const std::string& certPath = "");
    commonInterfaces::ResultCode get(
            const std::string& url,
            std::ostream& response,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj);
    commonInterfaces::ResultCode download(
            const std::string& url,
            const std::string& path,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj,
            bool unpack = false,
            size_t size = 0);

    using HeaderResults = avsCommon::utils::error::Result<commonInterfaces::ResultCode, std::string>;

    HeaderResults getHeaders(const std::string& url);
    HeaderResults getHeadersAuthorized(const std::string& url);

    commonInterfaces::ResultCode getAndDownloadMultipart(
            const std::string& url,
            std::shared_ptr<ResponseSink> sink,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj);

    static std::string getValueFromHeaders(const std::string& headers, const std::string& key);

private:
    explicit CurlWrapper(
            bool isThrottled,
            std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate,
            std::string certPath = "");

    // Initializes the object, returns true if successful.
    bool init();

    bool getAuthorizationHeader(std::string& header);

    commonInterfaces::ResultCode stream(
            const std::string& fullUrl,
            std::ostream& responseStream,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj);
    commonInterfaces::ResultCode streamToFile(
            const std::string& downloadUrl,
            const std::string& filePath,
            size_t size,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj);

    commonInterfaces::ResultCode streamToQueue(
            const std::string& fullUrl,
            std::shared_ptr<DownloadChunkQueue> downloadChunkQueue,
            const std::weak_ptr<CurlProgressCallbackInterface>& callbackObj);

    bool unpack(std::shared_ptr<DownloadChunkQueue> downloadChunkQueue, const std::string& path);

    commonInterfaces::ResultCode checkHTTPStatusCode(bool logError = true);

    commonInterfaces::ResultCode setHTTPHEADER();

private:
    bool m_isThrottled;
    std::string m_certPath;
    CURLcode m_code;
    CURL* m_handle;
    char m_errorBuffer[CURL_ERROR_SIZE]{};
    std::string m_header;
    // the curl handle does not take ownership of the memory in headers, and the handle re-uses headers
    std::unique_ptr<curl_slist, void (*)(curl_slist*)> m_headers;
    std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::AuthDelegateInterface> m_authDelegate;
};
}  // namespace common
}  // namespace acsdkAssets
}  // namespace alexaClientSDK

#endif  // ACSDKASSETSCOMMON_CURLWRAPPER_H_