18
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-11-21 21:24:58 +01:00
Files
maszyna/editor/editorHttp.cpp
maj00r 988c0af589 fix(editor): the closing doesn't wait for a geoportal service that doesn't answer (#432)
* fix(editor): the closing doesn't wait for a geoportal service that doesn't answer

When geoportal.gov.pl took the connection and never answered, the
editor's closing stood still for tens of seconds and was killed: the
WinHTTP client was synchronous and looked at the stop only between the
reads of a body, so a request waiting for the answer held the closing
for the timeouts (up to 20 s for the answer, a few tries a square),
and the map of the place-picker downloaded with no stop at all, its
std::async future waited for to the end.

On Windows the client now uses WinHTTP asynchronously: each step is
waited for while the stop is looked at every 50 ms, and a stop closes
the request at once. The timeouts, the user agent, the size limit, the
errors and the body of a response with an error status stay as they
were. The map of the place-picker is given up when it goes. libcurl
looked at the stop during the whole transfer already.

The unit tests run the client against a local server that never
answers (given up within 0.4 s of the stop), one with a body of
100 kB and one with an error status.

* fix(editor): the capabilities of a WMS service being added don't hold the closing either

The reading of the layers of a WMS service the user adds ran on a
std::async future of the editor with no stop: closing the editor while
such a service didn't answer waited for its three tries. The reading
is given up when the editor goes, as the other downloads now are, and
editor_http_get, left with no callers, goes.

The unit test's silent server no longer waits for the client to close
its connection, and the requests to the local server are skipped when
the environment names a proxy, which couldn't reach it.

* fix(editor): the stop of the WMS reading outlives the future waiting for it

The flag was declared after the future of the reading, so it was
destroyed first while the future's destructor still waited for the
task reading it.

---------

Co-authored-by: maj00r <maj00r@host>
2026-11-21 10:40:07 +01:00

454 lines
14 KiB
C++

/*
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
*/
#include "stdafx.h"
#include "editor/editorHttp.hpp"
#if defined(_WIN32)
#include <winhttp.h>
#elif defined(EU07_WITH_CURL)
#include <curl/curl.h>
#endif
#include <cstdlib>
#include <filesystem>
#include <mutex>
#include <string>
namespace editor_http
{
#if defined(_WIN32) || defined(EU07_WITH_CURL)
namespace
{
// the most a response is read into memory: a map or tiles of a service the user typed may be any size
std::size_t constexpr kLargest{64u * 1024u * 1024u};
char const *const kTooLarge{"the response is over 64 MB"};
} // namespace
#endif
struct client::platform
{
#if defined(_WIN32)
HINTERNET session{nullptr};
#elif defined(EU07_WITH_CURL)
CURL *curl{nullptr};
#endif
};
#if defined(_WIN32)
namespace
{
DWORD constexpr kStopCheck{50}; // ms between the looks at whether the transfer is to be given up
// what the callback of WinHTTP hands over to the thread waiting for it
struct transfer_state
{
HANDLE done{::CreateEventW(nullptr, FALSE, FALSE, nullptr)}; // the operation begun finished or failed
HANDLE closed{::CreateEventW(nullptr, TRUE, FALSE, nullptr)}; // the request is called back no more
DWORD error{ERROR_SUCCESS}; // of the operation that failed
DWORD size{0}; // bytes available or read
transfer_state() = default;
transfer_state(transfer_state const &) = delete;
transfer_state &operator=(transfer_state const &) = delete;
~transfer_state()
{
if (done != nullptr)
::CloseHandle(done);
if (closed != nullptr)
::CloseHandle(closed);
}
};
void CALLBACK on_status(HINTERNET, DWORD_PTR const Context, DWORD const Status, LPVOID const Info, DWORD const Length)
{
auto *state{reinterpret_cast<transfer_state *>(Context)};
if (state == nullptr)
return;
switch (Status)
{
case WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE:
case WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE:
break;
case WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE:
state->size = *static_cast<DWORD const *>(Info);
break;
case WINHTTP_CALLBACK_STATUS_READ_COMPLETE:
state->size = Length;
break;
case WINHTTP_CALLBACK_STATUS_REQUEST_ERROR:
state->error = static_cast<WINHTTP_ASYNC_RESULT const *>(Info)->dwError;
break;
case WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING:
::SetEvent(state->closed);
return;
default:
return;
}
::SetEvent(state->done);
}
// one GET on a connection of its own. the steps of WinHTTP are asynchronous and waited for while the stop is looked at, so a
// transfer is given up at once also while a service keeps the connection waiting: the closing of the editor doesn't wait for
// the timeouts of a service that doesn't answer
class transfer
{
public:
transfer(stop_check const &Stop, std::string &Error) :
m_stop(Stop),
m_error(Error)
{
}
~transfer()
{
close();
}
transfer(transfer const &) = delete;
transfer &operator=(transfer const &) = delete;
bool open(HINTERNET const Session, std::wstring const &Host, INTERNET_PORT const Port, std::wstring const &Path, bool const Secure)
{
if (m_state.done == nullptr || m_state.closed == nullptr)
return failed(::GetLastError());
m_connection = ::WinHttpConnect(Session, Host.c_str(), Port, 0);
if (m_connection == nullptr)
return failed(::GetLastError());
m_request = ::WinHttpOpenRequest(m_connection, L"GET", Path.c_str(), nullptr, WINHTTP_NO_REFERER, WINHTTP_DEFAULT_ACCEPT_TYPES, Secure ? WINHTTP_FLAG_SECURE : 0);
if (m_request == nullptr)
return failed(::GetLastError());
auto context{reinterpret_cast<DWORD_PTR>(&m_state)};
if (false == ::WinHttpSetOption(m_request, WINHTTP_OPTION_CONTEXT_VALUE, &context, sizeof(context)))
return failed(::GetLastError());
if (::WinHttpSetStatusCallback(m_request, on_status, WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS | WINHTTP_CALLBACK_FLAG_HANDLES, 0) == WINHTTP_INVALID_STATUS_CALLBACK)
return failed(::GetLastError());
m_called_back = true;
return true;
}
bool send()
{
return step([this]() { return ::WinHttpSendRequest(m_request, WINHTTP_NO_ADDITIONAL_HEADERS, 0, WINHTTP_NO_REQUEST_DATA, 0, 0, reinterpret_cast<DWORD_PTR>(&m_state)); });
}
bool receive()
{
return step([this]() { return ::WinHttpReceiveResponse(m_request, nullptr); });
}
DWORD status() const
{
DWORD status{0};
DWORD size{sizeof(status)};
::WinHttpQueryHeaders(m_request, WINHTTP_QUERY_STATUS_CODE | WINHTTP_QUERY_FLAG_NUMBER, WINHTTP_HEADER_NAME_BY_INDEX, &status, &size, WINHTTP_NO_HEADER_INDEX);
return status;
}
// the whole body of the response
bool read_all(std::vector<std::uint8_t> &Out)
{
while (true)
{
if (m_stop())
{
m_error = "cancelled";
return false;
}
if (false == step([this]() { return ::WinHttpQueryDataAvailable(m_request, nullptr); }))
return false;
auto const available{m_state.size};
if (available == 0)
return true;
if (Out.size() + available > kLargest)
{
m_error = kTooLarge;
Out.clear();
return false;
}
auto const offset{Out.size()};
Out.resize(offset + available);
auto const read{step([this, &Out, offset, available]() { return ::WinHttpReadData(m_request, Out.data() + offset, available, nullptr); })};
Out.resize(offset + (read ? m_state.size : 0));
if (false == read)
return false;
}
}
void close()
{
if (m_request != nullptr)
{
::WinHttpCloseHandle(m_request);
m_request = nullptr;
// the closing is the last callback: after it the state, and the buffer of a read broken off, are no longer written to
if (m_called_back)
::WaitForSingleObject(m_state.closed, INFINITE);
m_called_back = false;
}
if (m_connection != nullptr)
{
::WinHttpCloseHandle(m_connection);
m_connection = nullptr;
}
}
private:
bool failed(DWORD const Code)
{
m_error = "WinHTTP error " + std::to_string(Code);
return false;
}
// begins an operation and waits for it: false when it failed, or a stop was asked for meanwhile
template <typename Begin> bool step(Begin const &Operation)
{
m_state.error = ERROR_SUCCESS;
if (false == Operation())
return failed(::GetLastError());
while (::WaitForSingleObject(m_state.done, kStopCheck) != WAIT_OBJECT_0)
{
if (m_stop())
{
// closed at once: the operation broken off doesn't write into the buffer any more once this returns
close();
m_error = "cancelled";
return false;
}
}
if (m_state.error != ERROR_SUCCESS)
return failed(m_state.error);
return true;
}
stop_check const &m_stop;
std::string &m_error;
transfer_state m_state;
HINTERNET m_connection{nullptr};
HINTERNET m_request{nullptr};
bool m_called_back{false}; // the closing of the request is called back
};
} // namespace
client::client() :
m_platform(std::make_unique<platform>())
{
wchar_t const *agent = L"MaSzyna-editor";
#ifdef WINHTTP_ACCESS_TYPE_AUTOMATIC_PROXY
m_platform->session = ::WinHttpOpen(agent, WINHTTP_ACCESS_TYPE_AUTOMATIC_PROXY, WINHTTP_NO_PROXY_NAME, WINHTTP_NO_PROXY_BYPASS, WINHTTP_FLAG_ASYNC);
#endif
if (m_platform->session == nullptr) // automatic proxy needs windows 8.1+
m_platform->session = ::WinHttpOpen(agent, WINHTTP_ACCESS_TYPE_DEFAULT_PROXY, WINHTTP_NO_PROXY_NAME, WINHTTP_NO_PROXY_BYPASS, WINHTTP_FLAG_ASYNC);
if (m_platform->session != nullptr)
::WinHttpSetTimeouts(m_platform->session, 10000, 10000, 15000, 20000);
}
client::~client()
{
if (m_platform->session != nullptr)
::WinHttpCloseHandle(m_platform->session);
}
bool client::get(std::string const &Url, std::vector<std::uint8_t> &Out, std::string &Error, stop_check const &Stop)
{
Out.clear();
if (m_platform->session == nullptr)
{
Error = "WinHttpOpen failed (" + std::to_string(::GetLastError()) + ")";
return false;
}
// the address as the user typed or pasted it, in utf-8
std::wstring url;
if (auto const size{::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, Url.data(), static_cast<int>(Url.size()), nullptr, 0)}; size > 0)
{
url.resize(static_cast<std::size_t>(size));
::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, Url.data(), static_cast<int>(Url.size()), url.data(), size);
}
URL_COMPONENTS parts{};
parts.dwStructSize = sizeof(parts);
parts.dwSchemeLength = static_cast<DWORD>(-1);
parts.dwHostNameLength = static_cast<DWORD>(-1);
parts.dwUrlPathLength = static_cast<DWORD>(-1);
parts.dwExtraInfoLength = static_cast<DWORD>(-1);
if (url.empty() || !::WinHttpCrackUrl(url.c_str(), 0, 0, &parts))
{
Error = "invalid url";
return false;
}
std::wstring const host(parts.lpszHostName, parts.dwHostNameLength);
std::wstring const path = std::wstring(parts.lpszUrlPath, parts.dwUrlPathLength) + std::wstring(parts.lpszExtraInfo, parts.dwExtraInfoLength);
transfer request{Stop, Error};
if (false == request.open(m_platform->session, host, parts.nPort, path, parts.nScheme == INTERNET_SCHEME_HTTPS) || false == request.send() || false == request.receive())
return false;
auto const status{request.status()};
if (false == request.read_all(Out))
return false;
request.close();
if (status != 200)
{
Error = "HTTP " + std::to_string(status);
return false;
}
return true;
}
#elif defined(EU07_WITH_CURL)
namespace
{
// the file of the certificates https is checked with. the libcurl bundled with the game knows only the one of the system it
// was built on (/etc/ssl/certs/ca-certificates.crt of Debian and Ubuntu), which Fedora, RHEL and openSUSE don't have: there
// every download failed. the file named by the user first, then the ones the distributions keep; empty leaves libcurl's own
std::string const &certificates_file()
{
static std::string const file{[]() {
std::error_code error;
for (char const *variable : {"SSL_CERT_FILE", "CURL_CA_BUNDLE"})
{
if (char const *value{std::getenv(variable)}; (value != nullptr) && (*value != '\0') && std::filesystem::is_regular_file(value, error))
return std::string{value};
}
for (char const *candidate : {
"/etc/ssl/certs/ca-certificates.crt", // Debian, Ubuntu, Arch, SteamOS, Gentoo, NixOS
"/etc/pki/tls/certs/ca-bundle.crt", // Fedora, RHEL
"/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem", // Fedora, RHEL
"/etc/ssl/ca-bundle.pem", // openSUSE
"/etc/ssl/cert.pem", // Alpine, the BSDs, macOS
})
{
if (std::filesystem::is_regular_file(candidate, error))
return std::string{candidate};
}
return std::string{};
}()};
return file;
}
} // namespace
client::client() :
m_platform(std::make_unique<platform>())
{
static std::once_flag initialized;
std::call_once(initialized, []() { ::curl_global_init(CURL_GLOBAL_DEFAULT); });
m_platform->curl = ::curl_easy_init();
}
client::~client()
{
if (m_platform->curl != nullptr)
::curl_easy_cleanup(m_platform->curl);
}
bool client::get(std::string const &Url, std::vector<std::uint8_t> &Out, std::string &Error, stop_check const &Stop)
{
Out.clear();
if (m_platform->curl == nullptr)
{
Error = "curl_easy_init failed";
return false;
}
struct sink
{
std::vector<std::uint8_t> *out;
bool over{false};
} received{&Out};
auto const write = +[](char *Data, std::size_t Size, std::size_t Count, void *User) -> std::size_t {
auto *into = static_cast<sink *>(User);
if (into->out->size() + Size * Count > kLargest)
{
// fewer bytes taken than given stops the transfer
into->over = true;
return 0;
}
into->out->insert(into->out->end(), Data, Data + Size * Count);
return Size * Count;
};
auto const progress = +[](void *User, curl_off_t, curl_off_t, curl_off_t, curl_off_t) -> int { return (*static_cast<stop_check const *>(User))() ? 1 : 0; };
::curl_easy_reset(m_platform->curl);
::curl_easy_setopt(m_platform->curl, CURLOPT_URL, Url.c_str());
::curl_easy_setopt(m_platform->curl, CURLOPT_USERAGENT, "MaSzyna-editor");
if (auto const &certificates{certificates_file()}; false == certificates.empty())
{
::curl_easy_setopt(m_platform->curl, CURLOPT_CAINFO, certificates.c_str());
#if LIBCURL_VERSION_NUM >= 0x073400
// an https proxy is checked with the same file
::curl_easy_setopt(m_platform->curl, CURLOPT_PROXY_CAINFO, certificates.c_str());
#endif
}
::curl_easy_setopt(m_platform->curl, CURLOPT_FOLLOWLOCATION, 1L);
::curl_easy_setopt(m_platform->curl, CURLOPT_MAXREDIRS, 10L);
// http kept for the services the user types; nothing else, also where a redirect leads
#if LIBCURL_VERSION_NUM >= 0x075500
::curl_easy_setopt(m_platform->curl, CURLOPT_PROTOCOLS_STR, "https,http");
::curl_easy_setopt(m_platform->curl, CURLOPT_REDIR_PROTOCOLS_STR, "https,http");
#else
::curl_easy_setopt(m_platform->curl, CURLOPT_PROTOCOLS, static_cast<long>(CURLPROTO_HTTPS | CURLPROTO_HTTP));
::curl_easy_setopt(m_platform->curl, CURLOPT_REDIR_PROTOCOLS, static_cast<long>(CURLPROTO_HTTPS | CURLPROTO_HTTP));
#endif
::curl_easy_setopt(m_platform->curl, CURLOPT_MAXFILESIZE_LARGE, static_cast<curl_off_t>(kLargest));
::curl_easy_setopt(m_platform->curl, CURLOPT_NOSIGNAL, 1L);
::curl_easy_setopt(m_platform->curl, CURLOPT_CONNECTTIMEOUT, 10L);
::curl_easy_setopt(m_platform->curl, CURLOPT_LOW_SPEED_LIMIT, 1L);
::curl_easy_setopt(m_platform->curl, CURLOPT_LOW_SPEED_TIME, 20L);
::curl_easy_setopt(m_platform->curl, CURLOPT_WRITEFUNCTION, write);
::curl_easy_setopt(m_platform->curl, CURLOPT_WRITEDATA, &received);
::curl_easy_setopt(m_platform->curl, CURLOPT_NOPROGRESS, 0L);
::curl_easy_setopt(m_platform->curl, CURLOPT_XFERINFOFUNCTION, progress);
::curl_easy_setopt(m_platform->curl, CURLOPT_XFERINFODATA, const_cast<stop_check *>(&Stop));
CURLcode const code = ::curl_easy_perform(m_platform->curl);
if (code != CURLE_OK)
{
Error = (received.over || code == CURLE_FILESIZE_EXCEEDED ? kTooLarge : ::curl_easy_strerror(code));
Out.clear();
return false;
}
long status{0};
::curl_easy_getinfo(m_platform->curl, CURLINFO_RESPONSE_CODE, &status);
if (status != 200)
{
Error = "HTTP " + std::to_string(status);
return false;
}
return true;
}
#else
client::client() = default;
client::~client() = default;
bool client::get(std::string const &, std::vector<std::uint8_t> &Out, std::string &Error, stop_check const &)
{
Out.clear();
Error = "no http client in this build";
return false;
}
#endif
bool available()
{
#if defined(_WIN32) || defined(EU07_WITH_CURL)
return true;
#else
return false;
#endif
}
} // namespace editor_http