Merge branch 'dev-add-check-response-body-length' into 'master' (merge request !66)

修复下载对象时没校验实际接收的数据长度，客户端网络环境差时可能导致下载数据不全但不报错的异常问题

Author: zackcao

include/cos_defines.h

@@ -12,7 +12,7 @@
 
 namespace qcloud_cos {
 
-#define COS_CPP_SDK_VERSON "v5.5.18"
+#define COS_CPP_SDK_VERSON "v5.5.19"
 
 /// 路径分隔符
 const char kPathDelimiter[] = "/";

include/util/http_sender.h

@@ -33,7 +33,7 @@ class HttpSender {
                          bool is_check_md5 = false,
                          bool is_verify_cert = true,
                          const std::string& ca_location = "",
-                         SSLCtxCallback ssl_ctx_cb = nullptr,
+                         const SSLCtxCallback& ssl_ctx_cb = nullptr,
                          void *user_data = nullptr);
 
   static int SendRequest(const SharedTransferHandler& handler,
@@ -48,43 +48,45 @@ class HttpSender {
                          bool is_check_md5 = false,
                          bool is_verify_cert = true,
                          const std::string& ca_location = "",
-                         SSLCtxCallback ssl_ctx_cb = nullptr,
+                         const SSLCtxCallback& ssl_ctx_cb = nullptr,
                          void *user_data = nullptr);
 
   static int SendRequest(const SharedTransferHandler& handler,
                          const std::string& http_method,
                          const std::string& url_str,
                          const std::map<std::string, std::string>& req_params,
                          const std::map<std::string, std::string>& req_headers,
-                         std::istream& is,
+                         std::istream& is, // 流式输入，用于传输请求正文
                          uint64_t conn_timeout_in_ms,
                          uint64_t recv_timeout_in_ms,
                          std::map<std::string, std::string>* resp_headers,
-                         std::ostream& resp_stream,
+                         std::ostream& resp_stream, // 流式输出，用于接收响应正文
                          std::string* err_msg,
                          bool is_check_md5 = false,
                          bool is_verify_cert = true,
                          const std::string& ca_location = "",
-                         SSLCtxCallback ssl_ctx_cb = nullptr,
+                         const SSLCtxCallback& ssl_ctx_cb = nullptr,
                          void *user_data = nullptr,
-                         const char *req_body_buf = nullptr,
+                         const char *req_body_buf = nullptr,  // 可选的缓冲区
                          size_t req_body_len = 0);
 
   static int SendRequest(const SharedTransferHandler& handler,
                          const std::string& http_method,
                          const std::string& url_str,
                          const std::map<std::string, std::string>& req_params,
                          const std::map<std::string, std::string>& req_headers,
-                         const std::string& req_body,
+                         const std::string& req_body, // 字符串输入，用于传输请求正文
                          uint64_t conn_timeout_in_ms,
                          uint64_t recv_timeout_in_ms,
                          std::map<std::string, std::string>* resp_headers,
-                         std::string* xml_err_str, std::ostream& resp_stream,
-                         std::string* err_msg, uint64_t* real_byte,
+                         std::string* xml_err_str,  // 额外的错误信息, 用于响应返回非 2xx 错误码时, 传输报错响应信息
+                         std::ostream& resp_stream, // 流式输出, 用于传输响应正文
+                         std::string* err_msg, 
+                         uint64_t* real_byte, // 实际接收字节数
                          bool is_check_md5 = false,
                          bool is_verify_cert = true,
                          const std::string& ca_location = "",
-                         SSLCtxCallback ssl_ctx_cb = nullptr,
+                         const SSLCtxCallback& ssl_ctx_cb = nullptr,
                          void *user_data = nullptr);
 };
 

src/op/base_op.cpp

@@ -320,7 +320,7 @@ CosResult BaseOp::DownloadRequest(const std::string &host, const std::string &pa
     result.SetFail();
     result.SetErrorMsg("Download failed with incomplete file");
     SDK_LOG_ERR("Response content length %" PRIu64
-                "is not same to real recv byte %" PRIu64,
+                " is not same to real recv byte %" PRIu64,
                 resp->GetContentLength(), real_byte);
   }
 

src/op/file_download_task.cpp

@@ -116,24 +116,27 @@ void FileDownTask::DownTask() {
 }
 
 void FileDownTask::SendRequestOnce(std::string domain) {
-    std::string full_url = m_op_util.GetRealUrl(domain, m_path, m_is_https);
-    m_http_status = HttpSender::SendRequest(m_handler, "GET", full_url, m_params, m_headers, "", m_conn_timeout_in_ms,
-        m_recv_timeout_in_ms, &m_resp_headers, &m_resp, &m_err_msg, false, m_verify_cert, m_ca_location, m_ssl_ctx_cb,
-        m_user_data);
-    //}
-    // 当实际长度小于请求的数据长度时httpcode为206
-    if (m_http_status != 200 && m_http_status != 206) {
-        m_is_task_success = false;
-        m_real_down_len = 0;
-        return;
-    }
+  m_resp_headers.clear();
+  m_resp = "";
 
-    size_t buf_max_size = m_data_len;
-    size_t len = std::min(m_resp.length(), buf_max_size);
-    memcpy(m_data_buf_ptr, m_resp.c_str(), len);
-    m_real_down_len = len;
-    m_is_task_success = true;
-    m_resp = "";
+  std::string full_url = m_op_util.GetRealUrl(domain, m_path, m_is_https);
+  m_http_status = HttpSender::SendRequest(m_handler, "GET", full_url, m_params, m_headers, "", m_conn_timeout_in_ms,
+      m_recv_timeout_in_ms, &m_resp_headers, &m_resp, &m_err_msg, false, m_verify_cert, m_ca_location, m_ssl_ctx_cb,
+      m_user_data);
+
+  // 当实际长度小于请求的数据长度时httpcode为206
+  if (m_http_status != 200 && m_http_status != 206) {
+      m_is_task_success = false;
+      m_real_down_len = 0;
+      return;
+  }
+
+  size_t buf_max_size = m_data_len;
+  size_t len = std::min(m_resp.length(), buf_max_size);
+  memcpy(m_data_buf_ptr, m_resp.c_str(), len);
+  m_real_down_len = len;
+  m_is_task_success = true;
+  m_resp = "";
 }
 
 }  // namespace qcloud_cos

src/trsf/transfer_handler.cpp

@@ -1,7 +1,6 @@
 #include "trsf/transfer_handler.h"
 #include <iostream>
 #include "Poco/Buffer.h"
-#include "Poco/StreamCopier.h"
 #include "response/object_resp.h"
 #include "request/object_req.h"
 #include "trsf/async_context.h"
@@ -209,10 +208,9 @@ HandleStreamCopier::handleCopyStream(const SharedTransferHandler& handler,
   return len;
 }
 
-std::streamsize
-HandleStreamCopier::handleCopyStream(const SharedTransferHandler& handler,
-                                     std::istream& istr, std::ostream& ostr,
-                                     std::size_t bufferSize) {
+// 代码主要逻辑复制了 Poco::StreamCopier::copyStream(io_tmp, resp_stream) 的代码, 内部加入了客户取消操作的判断逻
+std::streamsize HandleStreamCopier::handleCopyStream(
+    const SharedTransferHandler& handler, std::istream& istr, std::ostream& ostr, std::size_t bufferSize) {
   poco_assert(bufferSize > 0);
 
   Poco::Buffer<char> buffer(bufferSize);