Downloads in WK2 on Windows should write resume data to bundle
[WebKit-https.git] / Source / WebKit2 / WebProcess / Downloads / Download.h
1 /*
2  * Copyright (C) 2010 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 USE(CFNETWORK)
42 #include <CFNetwork/CFURLDownloadPriv.h>
43 #endif
44
45 namespace CoreIPC {
46     class DataReference;
47 }
48
49 namespace WebCore {
50     class ResourceError;
51     class ResourceHandle;
52     class ResourceResponse;
53 }
54
55 namespace WebKit {
56
57 class SandboxExtension;
58 class WebPage;
59
60 class Download : public CoreIPC::MessageSender<Download> {
61     WTF_MAKE_NONCOPYABLE(Download);
62 public:
63     static PassOwnPtr<Download> create(uint64_t downloadID, const WebCore::ResourceRequest&);
64     ~Download();
65
66     // Used by MessageSender.
67     CoreIPC::Connection* connection() const;
68     uint64_t destinationID() const { return downloadID(); }
69
70     void start(WebPage* initiatingWebPage);
71     void startWithHandle(WebPage* initiatingPage, WebCore::ResourceHandle*, const WebCore::ResourceRequest& initialRequest, const WebCore::ResourceResponse&);
72     void cancel();
73
74     uint64_t downloadID() const { return m_downloadID; }
75
76     void didStart();
77     void didReceiveResponse(const WebCore::ResourceResponse&);
78     void didReceiveData(uint64_t length);
79     bool shouldDecodeSourceDataOfMIMEType(const String& mimeType);
80     String decideDestinationWithSuggestedFilename(const String& filename, bool& allowOverwrite);
81     void didCreateDestination(const String& path);
82     void didFinish();
83     void didFail(const WebCore::ResourceError&, const CoreIPC::DataReference& resumeData);
84     void didCancel(const CoreIPC::DataReference& resumeData);
85     void didDecideDestination(const String&, bool allowOverwrite);
86
87 #if USE(CFNETWORK)
88     const String& destination() const { return m_destination; }
89 #endif
90
91 private:
92     Download(uint64_t downloadID, const WebCore::ResourceRequest&);
93
94     void platformInvalidate();
95
96     uint64_t m_downloadID;
97     WebCore::ResourceRequest m_request;
98
99     RefPtr<SandboxExtension> m_sandboxExtension;
100
101 #if PLATFORM(MAC)
102     RetainPtr<NSURLDownload> m_nsURLDownload;
103     RetainPtr<WKDownloadAsDelegate> m_delegate;
104 #endif
105 #if USE(CFNETWORK)
106     String m_destination;
107     String m_bundlePath;
108     RetainPtr<CFURLDownloadRef> m_download;
109 #endif
110 };
111
112 } // namespace WebKit
113
114 #endif // Download_h