<rdar://problem/13194263> Crashes in NetworkProcess due to threading issues
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / NetworkResourceLoader.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 #ifndef NetworkResourceLoader_h
27 #define NetworkResourceLoader_h
28
29 #if ENABLE(NETWORK_PROCESS)
30
31 #include "MessageSender.h"
32 #include "SchedulableLoader.h"
33 #include "ShareableResource.h"
34 #include <WebCore/ResourceHandleClient.h>
35 #include <WebCore/ResourceLoaderOptions.h>
36 #include <WebCore/RunLoop.h>
37
38 namespace WebCore {
39 class ResourceBuffer;
40 class ResourceHandle;
41 class ResourceRequest;
42 }
43
44 namespace WebKit {
45
46 class NetworkConnectionToWebProcess;
47 class RemoteNetworkingContext;
48
49 class NetworkResourceLoader : public SchedulableLoader, public WebCore::ResourceHandleClient, public CoreIPC::MessageSender<NetworkResourceLoader> {
50 public:
51     static RefPtr<NetworkResourceLoader> create(const NetworkResourceLoadParameters& parameters, NetworkConnectionToWebProcess* connection)
52     {
53         return adoptRef(new NetworkResourceLoader(parameters, connection));
54     }
55     
56     ~NetworkResourceLoader();
57
58     // Used by MessageSender.
59     CoreIPC::Connection* connection() const;
60     uint64_t destinationID() const;
61     
62     virtual void start() OVERRIDE;
63     virtual void connectionToWebProcessDidClose() OVERRIDE;
64         
65     // ResourceHandleClient methods
66     virtual void willSendRequestAsync(WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) OVERRIDE;
67     virtual void didSendData(WebCore::ResourceHandle*, unsigned long long bytesSent, unsigned long long totalBytesToBeSent) OVERRIDE;
68     virtual void didReceiveResponse(WebCore::ResourceHandle*, const WebCore::ResourceResponse&) OVERRIDE;
69     virtual void didReceiveData(WebCore::ResourceHandle*, const char*, int, int encodedDataLength) OVERRIDE;
70     virtual void didReceiveCachedMetadata(WebCore::ResourceHandle*, const char*, int) OVERRIDE;
71     virtual void didFinishLoading(WebCore::ResourceHandle*, double finishTime) OVERRIDE;
72     virtual void didFail(WebCore::ResourceHandle*, const WebCore::ResourceError&) OVERRIDE;
73     virtual void wasBlocked(WebCore::ResourceHandle*) OVERRIDE;
74     virtual void cannotShowURL(WebCore::ResourceHandle*) OVERRIDE;
75     virtual void shouldUseCredentialStorageAsync(WebCore::ResourceHandle*) OVERRIDE;
76     virtual void didReceiveAuthenticationChallenge(WebCore::ResourceHandle*, const WebCore::AuthenticationChallenge&) OVERRIDE;
77     virtual void didCancelAuthenticationChallenge(WebCore::ResourceHandle*, const WebCore::AuthenticationChallenge&) OVERRIDE;
78     virtual bool usesAsyncCallbacks() OVERRIDE { return true; }
79
80 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
81     virtual void canAuthenticateAgainstProtectionSpaceAsync(WebCore::ResourceHandle*, const WebCore::ProtectionSpace&);
82 #endif
83
84 #if USE(NETWORK_CFDATA_ARRAY_CALLBACK)
85     virtual bool supportsDataArray() OVERRIDE;
86     virtual void didReceiveDataArray(WebCore::ResourceHandle*, CFArrayRef) OVERRIDE;
87 #endif
88
89 #if PLATFORM(MAC)
90     static size_t fileBackedResourceMinimumSize();
91     virtual void willCacheResponseAsync(WebCore::ResourceHandle*, NSCachedURLResponse *);
92     virtual void willStopBufferingData(WebCore::ResourceHandle*, const char*, int) OVERRIDE;
93 #endif // PLATFORM(MAC)
94
95     // Message handlers.
96     void didReceiveNetworkResourceLoaderMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&);
97
98 private:
99     NetworkResourceLoader(const NetworkResourceLoadParameters&, NetworkConnectionToWebProcess*);
100
101     void continueWillSendRequest(const WebCore::ResourceRequest& newRequest);
102 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
103     void continueCanAuthenticateAgainstProtectionSpace(bool);
104 #endif
105
106     void scheduleCleanupOnMainThread();
107     static void performCleanups(void*);
108     void cleanup();
109     
110     void platformDidReceiveResponse(const WebCore::ResourceResponse&);
111
112     template<typename U> bool sendAbortingOnFailure(const U& message);
113     template<typename U> bool sendSyncAbortingOnFailure(const U& message, const typename U::Reply& reply);
114     void abortInProgressLoad();
115
116     void tryGetShareableHandleForResource(ShareableResource::Handle&);
117
118     RefPtr<RemoteNetworkingContext> m_networkingContext;
119     RefPtr<WebCore::ResourceHandle> m_handle;
120
121     // Keep the suggested request around while asynchronously asking to update it, because some parts of the request don't survive IPC.
122     WebCore::ResourceRequest m_suggestedRequestForWillSendRequest;
123
124     uint64_t m_bytesReceived;
125
126 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
127     void diskCacheTimerFired();
128     WebCore::RunLoop::Timer<NetworkResourceLoader> m_diskCacheTimer;
129 #endif
130 };
131
132 } // namespace WebKit
133
134 #endif // ENABLE(NETWORK_PROCESS)
135
136 #endif // NetworkResourceLoader_h