Add types for DownloadID and TaskIdentifier
[WebKit-https.git] / Source / WebKit2 / UIProcess / Downloads / DownloadProxy.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 DownloadProxy_h
27 #define DownloadProxy_h
28
29 #include "APIObject.h"
30 #include "Connection.h"
31 #include "DownloadID.h"
32 #include "SandboxExtension.h"
33 #include <WebCore/ResourceRequest.h>
34 #include <wtf/Forward.h>
35 #include <wtf/PassRefPtr.h>
36
37 namespace API {
38 class Data;
39 }
40
41 namespace WebCore {
42     class AuthenticationChallenge;
43     class ResourceError;
44     class ResourceResponse;
45 }
46
47 namespace WebKit {
48
49 class DownloadProxyMap;
50 class WebPageProxy;
51 class WebProcessPool;
52
53 class DownloadProxy : public API::ObjectImpl<API::Object::Type::Download>, public IPC::MessageReceiver {
54 public:
55     static PassRefPtr<DownloadProxy> create(DownloadProxyMap&, WebProcessPool&, const WebCore::ResourceRequest&);
56     ~DownloadProxy();
57
58     DownloadID downloadID() const { return m_downloadID; }
59     const WebCore::ResourceRequest& request() const { return m_request; }
60     API::Data* resumeData() const { return m_resumeData.get(); }
61
62     void cancel();
63
64     void invalidate();
65     void processDidClose();
66
67     void didReceiveDownloadProxyMessage(IPC::Connection&, IPC::MessageDecoder&);
68     void didReceiveSyncDownloadProxyMessage(IPC::Connection&, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
69
70 private:
71     explicit DownloadProxy(DownloadProxyMap&, WebProcessPool&, const WebCore::ResourceRequest&);
72
73     // IPC::MessageReceiver
74     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
75     virtual void didReceiveSyncMessage(IPC::Connection&, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&) override;
76
77     // Message handlers.
78     void didStart(const WebCore::ResourceRequest&);
79     void didReceiveAuthenticationChallenge(const WebCore::AuthenticationChallenge&, uint64_t challengeID);
80     void didReceiveResponse(const WebCore::ResourceResponse&);
81     void didReceiveData(uint64_t length);
82     void shouldDecodeSourceDataOfMIMEType(const String& mimeType, bool& result);
83     void decideDestinationWithSuggestedFilename(const String& filename, String& destination, bool& allowOverwrite, SandboxExtension::Handle& sandboxExtensionHandle);
84     void didCreateDestination(const String& path);
85     void didFinish();
86     void didFail(const WebCore::ResourceError&, const IPC::DataReference& resumeData);
87     void didCancel(const IPC::DataReference& resumeData);
88
89     DownloadProxyMap& m_downloadProxyMap;
90     RefPtr<WebProcessPool> m_processPool;
91     DownloadID m_downloadID;
92
93     RefPtr<API::Data> m_resumeData;
94     WebCore::ResourceRequest m_request;
95 };
96
97 } // namespace WebKit
98
99 #endif // DownloadProxy_h