[SOUP] Add NetworkSession implementation and switch to use it
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / Downloads / Download.h
1 /*
2  * Copyright (C) 2010-2016 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 Download_h
27 #define Download_h
28
29 #include "DownloadID.h"
30 #include "MessageSender.h"
31 #include "SandboxExtension.h"
32 #include <WebCore/ResourceHandle.h>
33 #include <WebCore/ResourceHandleClient.h>
34 #include <WebCore/ResourceRequest.h>
35 #include <WebCore/SessionID.h>
36 #include <memory>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/RetainPtr.h>
39
40 #if USE(NETWORK_SESSION)
41 #if PLATFORM(COCOA)
42 OBJC_CLASS NSURLSessionDownloadTask;
43 typedef NSURLSessionDownloadTask* PlatformDownloadTaskRef;
44 #elif USE(SOUP)
45 namespace WebKit {
46 class NetworkDataTask;
47 }
48 typedef WebKit::NetworkDataTask* PlatformDownloadTaskRef;
49 #endif
50 #else // USE(NETWORK_SESSION)
51 #if PLATFORM(COCOA)
52 OBJC_CLASS NSURLDownload;
53 OBJC_CLASS WKDownloadAsDelegate;
54 #endif
55 #endif // USE(NETWORK_SESSION)
56
57 #if USE(CFURLCONNECTION)
58 #include <CFNetwork/CFURLDownloadPriv.h>
59 #endif
60
61 namespace IPC {
62 class DataReference;
63 }
64
65 namespace WebCore {
66 class AuthenticationChallenge;
67 class Credential;
68 class ResourceError;
69 class ResourceHandle;
70 class ResourceResponse;
71 }
72
73 namespace WebKit {
74
75 class DownloadManager;
76 class NetworkSession;
77 class WebPage;
78
79 class Download : public IPC::MessageSender {
80     WTF_MAKE_NONCOPYABLE(Download); WTF_MAKE_FAST_ALLOCATED;
81 public:
82 #if USE(NETWORK_SESSION)
83     Download(DownloadManager&, DownloadID, PlatformDownloadTaskRef, const WebCore::SessionID& sessionID, const String& suggestedFilename = { });
84 #endif
85     Download(DownloadManager&, DownloadID, const WebCore::ResourceRequest&, const String& suggestedFilename = { });
86
87     ~Download();
88
89     void start();
90     void startWithHandle(WebCore::ResourceHandle*, const WebCore::ResourceResponse&);
91     void resume(const IPC::DataReference& resumeData, const String& path, const SandboxExtension::Handle&);
92     void cancel();
93
94     DownloadID downloadID() const { return m_downloadID; }
95     const String& suggestedName() const { return m_suggestedName; }
96     const WebCore::ResourceRequest& request() const { return m_request; }
97
98 #if USE(NETWORK_SESSION)
99     void setSandboxExtension(RefPtr<SandboxExtension>&& sandboxExtension) { m_sandboxExtension = WTFMove(sandboxExtension); }
100 #else
101     void didReceiveAuthenticationChallenge(const WebCore::AuthenticationChallenge&);
102 #endif
103     void didStart();
104     void didReceiveResponse(const WebCore::ResourceResponse&);
105     void didReceiveData(uint64_t length);
106     bool shouldDecodeSourceDataOfMIMEType(const String& mimeType);
107 #if !USE(NETWORK_SESSION)
108     String decideDestinationWithSuggestedFilename(const String& filename, bool& allowOverwrite);
109 #endif
110     void decideDestinationWithSuggestedFilenameAsync(const String&);
111     void didDecideDownloadDestination(const String& destinationPath, const SandboxExtension::Handle&, bool allowOverwrite);
112     void continueDidReceiveResponse();
113     void didCreateDestination(const String& path);
114     void didFinish();
115     void platformDidFinish();
116     void didFail(const WebCore::ResourceError&, const IPC::DataReference& resumeData);
117     void didCancel(const IPC::DataReference& resumeData);
118
119 private:
120     // IPC::MessageSender
121     IPC::Connection* messageSenderConnection() override;
122     uint64_t messageSenderDestinationID() override;
123
124 #if !USE(NETWORK_SESSION)
125     void startNetworkLoad();
126     void startNetworkLoadWithHandle(WebCore::ResourceHandle*, const WebCore::ResourceResponse&);
127 #endif
128     void cancelNetworkLoad();
129
130     void platformInvalidate();
131
132     bool isAlwaysOnLoggingAllowed() const;
133
134     DownloadManager& m_downloadManager;
135     DownloadID m_downloadID;
136     WebCore::ResourceRequest m_request;
137
138     RefPtr<SandboxExtension> m_sandboxExtension;
139
140 #if USE(NETWORK_SESSION)
141 #if PLATFORM(COCOA)
142     RetainPtr<NSURLSessionDownloadTask> m_download;
143 #elif USE(SOUP)
144     RefPtr<NetworkDataTask> m_download;
145 #endif
146     WebCore::SessionID m_sessionID;
147 #else // USE(NETWORK_SESSION)
148 #if PLATFORM(COCOA)
149     RetainPtr<NSURLDownload> m_nsURLDownload;
150     RetainPtr<WKDownloadAsDelegate> m_delegate;
151 #endif
152 #endif // USE(NETWORK_SESSION)
153 #if USE(CFURLCONNECTION)
154     RetainPtr<CFURLDownloadRef> m_download;
155 #endif
156     std::unique_ptr<WebCore::ResourceHandleClient> m_downloadClient;
157     RefPtr<WebCore::ResourceHandle> m_resourceHandle;
158     String m_suggestedName;
159     bool m_hasReceivedData { false };
160 };
161
162 } // namespace WebKit
163
164 #endif // Download_h