#pragma once
#include "DownloadID.h"
#include "SandboxExtension.h"
#include <WebCore/Credential.h>
#include <WebCore/FrameLoaderTypes.h>
#include <WebCore/NetworkLoadMetrics.h>
#include <WebCore/ResourceLoaderOptions.h>
#include <WebCore/ResourceRequest.h>
#include <WebCore/StoredCredentialsPolicy.h>
#include <WebCore/Timer.h>
#include <pal/SessionID.h>
#include <wtf/CompletionHandler.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class AuthenticationChallenge;
class ResourceError;
class ResourceResponse;
class SharedBuffer;
}
namespace WebKit {
class NetworkLoadParameters;
class NetworkSession;
class PendingDownload;
enum class AuthenticationChallengeDisposition : uint8_t;
enum class NegotiatedLegacyTLS : bool;
using RedirectCompletionHandler = CompletionHandler<void(WebCore::ResourceRequest&&)>;
using ChallengeCompletionHandler = CompletionHandler<void(AuthenticationChallengeDisposition, const WebCore::Credential&)>;
using ResponseCompletionHandler = CompletionHandler<void(WebCore::PolicyAction)>;
class NetworkDataTaskClient {
public:
virtual void willPerformHTTPRedirection(WebCore::ResourceResponse&&, WebCore::ResourceRequest&&, RedirectCompletionHandler&&) = 0;
virtual void didReceiveChallenge(WebCore::AuthenticationChallenge&&, NegotiatedLegacyTLS, ChallengeCompletionHandler&&) = 0;
virtual void didReceiveResponse(WebCore::ResourceResponse&&, NegotiatedLegacyTLS, ResponseCompletionHandler&&) = 0;
virtual void didReceiveData(Ref<WebCore::SharedBuffer>&&) = 0;
virtual void didCompleteWithError(const WebCore::ResourceError&, const WebCore::NetworkLoadMetrics&) = 0;
virtual void didSendData(uint64_t totalBytesSent, uint64_t totalBytesExpectedToSend) = 0;
virtual void wasBlocked() = 0;
virtual void cannotShowURL() = 0;
virtual void wasBlockedByRestrictions() = 0;
virtual bool shouldCaptureExtraNetworkLoadMetrics() const { return false; }
void didCompleteWithError(const WebCore::ResourceError& error)
{
WebCore::NetworkLoadMetrics emptyMetrics;
didCompleteWithError(error, emptyMetrics);
}
virtual ~NetworkDataTaskClient() { }
};
class NetworkDataTask : public ThreadSafeRefCounted<NetworkDataTask, WTF::DestructionThread::Main>, public CanMakeWeakPtr<NetworkDataTask> {
public:
static Ref<NetworkDataTask> create(NetworkSession&, NetworkDataTaskClient&, const NetworkLoadParameters&);
virtual ~NetworkDataTask();
virtual void cancel() = 0;
virtual void resume() = 0;
virtual void invalidateAndCancel() = 0;
void didReceiveResponse(WebCore::ResourceResponse&&, NegotiatedLegacyTLS, ResponseCompletionHandler&&);
bool shouldCaptureExtraNetworkLoadMetrics() const;
enum class State {
Running,
Suspended,
Canceling,
Completed
};
virtual State state() const = 0;
NetworkDataTaskClient* client() const { return m_client; }
void clearClient() { m_client = nullptr; }
DownloadID pendingDownloadID() const { return m_pendingDownloadID; }
PendingDownload* pendingDownload() const { return m_pendingDownload; }
void setPendingDownloadID(DownloadID downloadID)
{
ASSERT(!m_pendingDownloadID.downloadID());
ASSERT(downloadID.downloadID());
m_pendingDownloadID = downloadID;
}
void setPendingDownload(PendingDownload& pendingDownload)
{
ASSERT(!m_pendingDownload);
m_pendingDownload = &pendingDownload;
}
virtual void setPendingDownloadLocation(const String& filename, SandboxExtension::Handle&&, bool ) { m_pendingDownloadLocation = filename; }
const String& pendingDownloadLocation() const { return m_pendingDownloadLocation; }
bool isDownload() const { return !!m_pendingDownloadID.downloadID(); }
const WebCore::ResourceRequest& firstRequest() const { return m_firstRequest; }
virtual String suggestedFilename() const { return String(); }
void setSuggestedFilename(const String& suggestedName) { m_suggestedFilename = suggestedName; }
const String& partition() { return m_partition; }
bool isTopLevelNavigation() const { return m_dataTaskIsForMainFrameNavigation; }
virtual String description() const;
PAL::SessionID sessionID() const;
NetworkSession* networkSession();
protected:
NetworkDataTask(NetworkSession&, NetworkDataTaskClient&, const WebCore::ResourceRequest&, WebCore::StoredCredentialsPolicy, bool shouldClearReferrerOnHTTPSToHTTPRedirect, bool dataTaskIsForMainFrameNavigation);
enum FailureType {
NoFailure,
BlockedFailure,
InvalidURLFailure,
RestrictedURLFailure
};
void failureTimerFired();
void scheduleFailure(FailureType);
FailureType m_scheduledFailureType { NoFailure };
WebCore::Timer m_failureTimer;
WeakPtr<NetworkSession> m_session;
NetworkDataTaskClient* m_client { nullptr };
PendingDownload* m_pendingDownload { nullptr };
DownloadID m_pendingDownloadID;
String m_user;
String m_password;
String m_partition;
#if USE(CREDENTIAL_STORAGE_WITH_NETWORK_SESSION)
WebCore::Credential m_initialCredential;
#endif
WebCore::StoredCredentialsPolicy m_storedCredentialsPolicy { WebCore::StoredCredentialsPolicy::DoNotUse };
String m_lastHTTPMethod;
String m_pendingDownloadLocation;
WebCore::ResourceRequest m_firstRequest;
bool m_shouldClearReferrerOnHTTPSToHTTPRedirect { true };
String m_suggestedFilename;
bool m_dataTaskIsForMainFrameNavigation { false };
};
}