Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Record active sockets in wxWebSessionCURL

Browse Source 
If a wxWebRequestCURL object is canceled or deleted before its transfer
is complete, we need to manually close its active socket.  Record each
transfer’s active socket in wxWebSessionCURL::SocketCallback so can use
it if needed.

Previously, this was done using curl_easy_getinfo, but this required
some compile time and run time checks and could fail in some specific
cases. Recording the socket ourselves significantly simplifies the code
and should always work.
This commit is contained in:
New Pagodi
2021-02-08 12:32:32 -06:00
parent 7105499561
commit ab63e73920
2 changed files with 42 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
include/wx/private/webrequest_curl.h
View File

@@ -168,12 +168,17 @@ private:
void ProcessSocketPollerResult(wxThreadEvent&);
void CheckForCompletedTransfers();
void FailRequest(CURL*, const wxString&);
void StopTransfer(CURL*);
void StopActiveTransfer(CURL*);
void RemoveActiveSocket(CURL*);
WX_DECLARE_HASH_MAP(CURL*, wxWebRequestCURL*, wxPointerHash, \
wxPointerEqual, TransferSet);
WX_DECLARE_HASH_MAP(CURL*, curl_socket_t, wxPointerHash, \
wxPointerEqual, CurlSocketMap);
TransferSet m_activeTransfers;
CurlSocketMap m_activeSockets;
SocketPoller* m_socketPoller;
wxTimer m_timeoutTimer;

117
src/common/webrequest_curl.cpp
View File

@@ -23,7 +23,7 @@
#endif
#include "wx/uri.h"
#include "wx/socket.h"
#include "wx/private/socket.h"
#include "wx/evtloop.h"
#ifdef __WINDOWS__
@@ -965,35 +965,18 @@ bool wxWebSessionCURL::StartRequest(wxWebRequestCURL & request)
void wxWebSessionCURL::CancelRequest(wxWebRequestCURL* request)
{
// If this transfer is currently active, stop it.
CURL* curl = request->GetHandle();
TransferSet::iterator it = m_activeTransfers.find(curl);
if ( it != m_activeTransfers.end() )
{
m_activeTransfers.erase(it);
}
curl_multi_remove_handle(m_handle, curl);
StopTransfer(curl);
StopActiveTransfer(curl);
request->SetState(wxWebRequest::State_Cancelled);
}
void wxWebSessionCURL::RequestHasTerminated(wxWebRequestCURL* request)
{
// If this transfer is currently active, stop it.
CURL* curl = request->GetHandle();
TransferSet::iterator it = m_activeTransfers.find(curl);
if ( it != m_activeTransfers.end() )
{
// The transfer the CURL handle is performing is still in progress, but
// the web request object it belongs to is being deleted. Since the
// next step will call curl_easy_cleanup and any calls on the CURL
// handle after cleanup are illegal, remove it from the CURLM
// multihandle now.
curl_multi_remove_handle(m_handle, curl);
m_activeTransfers.erase(it);
}
StopActiveTransfer(curl);
curl_easy_cleanup(curl);
}
@@ -1119,6 +1102,8 @@ void wxWebSessionCURL::ProcessSocketCallback(CURL* curl, curl_socket_t s,
wxFALLTHROUGH;
case CURL_POLL_INOUT:
{
m_activeSockets[curl] = s;
int pollAction = CurlPoll2SocketPoller(what);
bool socketIsMonitored = m_socketPoller->StartPolling(s,
pollAction);
@@ -1138,6 +1123,7 @@ void wxWebSessionCURL::ProcessSocketCallback(CURL* curl, curl_socket_t s,
break;
case CURL_POLL_REMOVE:
m_socketPoller->StopPolling(s);
RemoveActiveSocket(curl);
break;
default:
wxLogDebug("Unknown socket action in ProcessSocketCallback");
@@ -1197,6 +1183,7 @@ void wxWebSessionCURL::CheckForCompletedTransfers()
curl_multi_remove_handle(m_handle, curl);
request->HandleCompletion();
m_activeTransfers.erase(it);
RemoveActiveSocket(curl);
}
}
}
@@ -1209,74 +1196,50 @@ void wxWebSessionCURL::FailRequest(CURL* curl,const wxString& msg)
if ( it != m_activeTransfers.end() )
{
wxWebRequestCURL* request = it->second;
m_activeTransfers.erase(it);
curl_multi_remove_handle(m_handle, curl);
StopTransfer(curl);
StopActiveTransfer(curl);
request->SetState(wxWebRequest::State_Failed, msg);
}
}
void wxWebSessionCURL::StopTransfer(CURL* curl)
void wxWebSessionCURL::StopActiveTransfer(CURL* curl)
{
curl_socket_t activeSocket;
bool closeActiveSocket = true;
bool useLastSocket = false;
TransferSet::iterator it = m_activeTransfers.find(curl);
#if CURL_AT_LEAST_VERSION(7, 45, 0)
if ( CurlRuntimeAtLeastVersion(7, 45, 0) )
if ( it != m_activeTransfers.end() )
{
CURLcode code = curl_easy_getinfo(curl, CURLINFO_ACTIVESOCKET,
&activeSocket);
// Record the current active socket now since it should be removed from
// the m_activeSockets map when we call curl_multi_remove_handle.
curl_socket_t activeSocket = CURL_SOCKET_BAD;
CurlSocketMap::iterator it2 = m_activeSockets.find(curl);
if ( code != CURLE_OK || activeSocket == CURL_SOCKET_BAD )
if ( it2 != m_activeSockets.end() )
{
closeActiveSocket = false;
}
}
else
{
useLastSocket = true;
}
#else
useLastSocket = true;
#endif //CURL_AT_LEAST_VERSION(7, 45, 0)
// CURLINFO_ACTIVESOCKET is not available either at compile time or run
// time. So we must use the older CURLINFO_LASTSOCKET instead.
if ( useLastSocket )
{
#ifdef __WIN64__
// CURLINFO_LASTSOCKET won't work on 64 bit windows because it
// uses a long to retrive the socket. However sockets will be 64
// bit values. In this case there is nothing we can do.
closeActiveSocket = false;
#endif //__WIN64__
if ( closeActiveSocket )
{
long longSocket;
CURLcode code = curl_easy_getinfo(curl, CURLINFO_LASTSOCKET,
&longSocket);
if ( code == CURLE_OK && longSocket!= -1 )
{
activeSocket = static_cast<curl_socket_t>(longSocket);
}
else
{
closeActiveSocket = false;
}
}
activeSocket = it2->second;
}
if ( closeActiveSocket )
// Remove the CURL easy handle from the CURLM multi handle.
curl_multi_remove_handle(m_handle, curl);
// If the transfer was active, close its socket.
if ( activeSocket != CURL_SOCKET_BAD )
{
#ifdef __WINDOWS__
closesocket(activeSocket);
#else
close(activeSocket);
#endif
wxCloseSocket(activeSocket);
}
// Clean up the maps.
RemoveActiveSocket(curl);
m_activeTransfers.erase(it);
}
}
void wxWebSessionCURL::RemoveActiveSocket(CURL* curl)
{
CurlSocketMap::iterator it = m_activeSockets.find(curl);
if ( it != m_activeSockets.end() )
{
m_activeSockets.erase(it);
}
}