Remove an unneeded argument from FrameLoaderClient::download
[WebKit-https.git] / Source / WebKit2 / WebProcess / Downloads / Download.h
1 /*
2  * Copyright (C) 2010, 2011 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 "MessageSender.h"
30 #include <WebCore/ResourceRequest.h>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/PassOwnPtr.h>
33
34 #if PLATFORM(MAC)
35 #include <wtf/RetainPtr.h>
36
37 OBJC_CLASS NSURLDownload;
38 OBJC_CLASS WKDownloadAsDelegate;
39 #endif
40
41 #if PLATFORM(GTK)
42 #include <WebCore/ResourceHandle.h>
43 #include <WebCore/ResourceHandleClient.h>
44 #endif
45
46 #if USE(CFNETWORK)
47 #include <CFNetwork/CFURLDownloadPriv.h>
48 #endif
49
50 namespace CoreIPC {
51     class DataReference;
52 }
53
54 namespace WebCore {
55     class AuthenticationChallenge;
56     class Credential;
57     class ResourceError;
58     class ResourceHandle;
59     class ResourceResponse;
60 }
61
62 namespace WebKit {
63
64 class DownloadAuthenticationClient;
65 class SandboxExtension;
66 class WebPage;
67
68 #if PLATFORM(QT)
69 class QtFileDownloader;
70 #endif
71
72 class Download : public CoreIPC::MessageSender<Download> {
73     WTF_MAKE_NONCOPYABLE(Download);
74 public:
75     static PassOwnPtr<Download> create(uint64_t downloadID, const WebCore::ResourceRequest&);
76     ~Download();
77
78     // Used by MessageSender.
79     CoreIPC::Connection* connection() const;
80     uint64_t destinationID() const { return downloadID(); }
81
82     void start(WebPage* initiatingWebPage);
83     void startWithHandle(WebPage* initiatingPage, WebCore::ResourceHandle*, const WebCore::ResourceResponse&);
84     void cancel();
85
86     uint64_t downloadID() const { return m_downloadID; }
87
88     void didStart();
89     void didReceiveAuthenticationChallenge(const WebCore::AuthenticationChallenge&);
90     void didReceiveResponse(const WebCore::ResourceResponse&);
91     void didReceiveData(uint64_t length);
92     bool shouldDecodeSourceDataOfMIMEType(const String& mimeType);
93     String decideDestinationWithSuggestedFilename(const String& filename, bool& allowOverwrite);
94     void didCreateDestination(const String& path);
95     void didFinish();
96     void platformDidFinish();
97     void didFail(const WebCore::ResourceError&, const CoreIPC::DataReference& resumeData);
98     void didCancel(const CoreIPC::DataReference& resumeData);
99     void didDecideDestination(const String&, bool allowOverwrite);
100
101 #if PLATFORM(QT)
102     void startTransfer(const String& destination);
103 #endif
104
105 #if USE(CFNETWORK)
106     const String& destination() const { return m_destination; }
107     DownloadAuthenticationClient* authenticationClient();
108 #endif
109
110     // Authentication
111     static void receivedCredential(const WebCore::AuthenticationChallenge&, const WebCore::Credential&);
112     static void receivedRequestToContinueWithoutCredential(const WebCore::AuthenticationChallenge&);
113     static void receivedCancellation(const WebCore::AuthenticationChallenge&);
114
115     void useCredential(const WebCore::AuthenticationChallenge&, const WebCore::Credential&);
116     void continueWithoutCredential(const WebCore::AuthenticationChallenge&);
117     void cancelAuthenticationChallenge(const WebCore::AuthenticationChallenge&);
118
119 private:
120     Download(uint64_t downloadID, const WebCore::ResourceRequest&);
121
122     void platformInvalidate();
123
124     String retrieveDestinationWithSuggestedFilename(const String& filename, bool& allowOverwrite);
125
126     uint64_t m_downloadID;
127     WebCore::ResourceRequest m_request;
128
129     RefPtr<SandboxExtension> m_sandboxExtension;
130
131 #if PLATFORM(MAC)
132     RetainPtr<NSURLDownload> m_nsURLDownload;
133     RetainPtr<WKDownloadAsDelegate> m_delegate;
134 #endif
135     bool m_allowOverwrite;
136     String m_destination;
137     String m_bundlePath;
138 #if USE(CFNETWORK)
139     RetainPtr<CFURLDownloadRef> m_download;
140     RefPtr<DownloadAuthenticationClient> m_authenticationClient;
141 #endif
142 #if PLATFORM(QT)
143     QtFileDownloader* m_qtDownloader;
144 #endif
145 #if PLATFORM(GTK)
146     OwnPtr<WebCore::ResourceHandleClient> m_downloadClient;
147     RefPtr<WebCore::ResourceHandle> m_resourceHandle;
148 #endif
149 };
150
151 } // namespace WebKit
152
153 #endif // Download_h