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