Expose WebPageProxy identifier to the Network Process
[WebKit-https.git] / Source / WebKit / WebProcess / Network / WebResourceLoader.h
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Connection.h"
29 #include "MessageSender.h"
30 #include "ShareableResource.h"
31 #include "WebPageProxyIdentifier.h"
32 #include <WebCore/FrameIdentifier.h>
33 #include <WebCore/PageIdentifier.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36
37 namespace IPC {
38 class DataReference;
39 }
40
41 namespace WebCore {
42 class NetworkLoadMetrics;
43 class ResourceError;
44 class ResourceLoader;
45 class ResourceRequest;
46 class ResourceResponse;
47 }
48
49 namespace WebKit {
50
51 typedef uint64_t ResourceLoadIdentifier;
52
53 class WebResourceLoader : public RefCounted<WebResourceLoader>, public IPC::MessageSender {
54 public:
55     struct TrackingParameters {
56         WebPageProxyIdentifier webPageProxyID;
57         WebCore::PageIdentifier pageID;
58         WebCore::FrameIdentifier frameID;
59         ResourceLoadIdentifier resourceID { 0 };
60     };
61
62     static Ref<WebResourceLoader> create(Ref<WebCore::ResourceLoader>&&, const TrackingParameters&);
63
64     ~WebResourceLoader();
65
66     void didReceiveWebResourceLoaderMessage(IPC::Connection&, IPC::Decoder&);
67
68     WebCore::ResourceLoader* resourceLoader() const { return m_coreLoader.get(); }
69
70     void detachFromCoreLoader();
71
72     bool isAlwaysOnLoggingAllowed() const;
73
74 private:
75     WebResourceLoader(Ref<WebCore::ResourceLoader>&&, const TrackingParameters&);
76
77     // IPC::MessageSender
78     IPC::Connection* messageSenderConnection() const override;
79     uint64_t messageSenderDestinationID() const override;
80
81     void willSendRequest(WebCore::ResourceRequest&&, WebCore::ResourceResponse&&);
82     void didSendData(uint64_t bytesSent, uint64_t totalBytesToBeSent);
83     void didReceiveResponse(const WebCore::ResourceResponse&, bool needsContinueDidReceiveResponseMessage);
84     void didReceiveData(const IPC::DataReference&, int64_t encodedDataLength);
85     void didRetrieveDerivedData(const String& type, const IPC::DataReference&);
86     void didFinishResourceLoad(const WebCore::NetworkLoadMetrics&);
87     void didFailResourceLoad(const WebCore::ResourceError&);
88     void didBlockAuthenticationChallenge();
89
90     void stopLoadingAfterXFrameOptionsOrContentSecurityPolicyDenied(const WebCore::ResourceResponse&);
91
92 #if ENABLE(SHAREABLE_RESOURCE)
93     void didReceiveResource(const ShareableResource::Handle&);
94 #endif
95
96     RefPtr<WebCore::ResourceLoader> m_coreLoader;
97     TrackingParameters m_trackingParameters;
98     size_t m_numBytesReceived { 0 };
99
100 #if !ASSERT_DISABLED
101     bool m_isProcessingNetworkResponse { false };
102 #endif
103 };
104
105 } // namespace WebKit