Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / NetworkProcess / Downloads / DownloadManager.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 "NetworkDataTask.h"
30 #include "PendingDownload.h"
31 #include "SandboxExtension.h"
32 #include <WebCore/NotImplemented.h>
33 #include <wtf/Forward.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/Noncopyable.h>
36
37 namespace PAL {
38 class SessionID;
39 }
40
41 namespace WebCore {
42 class BlobDataFileReference;
43 class ResourceHandle;
44 class ResourceRequest;
45 class ResourceResponse;
46 }
47
48 namespace IPC {
49 class Connection;
50 class DataReference;
51 }
52
53 namespace WebKit {
54
55 class AuthenticationManager;
56 class Download;
57 class NetworkConnectionToWebProcess;
58 class NetworkLoad;
59 class PendingDownload;
60
61 class DownloadManager {
62     WTF_MAKE_NONCOPYABLE(DownloadManager);
63
64 public:
65     class Client {
66     public:
67         virtual ~Client() { }
68
69         virtual void didCreateDownload() = 0;
70         virtual void didDestroyDownload() = 0;
71         virtual IPC::Connection* downloadProxyConnection() = 0;
72         virtual AuthenticationManager& downloadsAuthenticationManager() = 0;
73         virtual void pendingDownloadCanceled(DownloadID) = 0;
74     };
75
76     explicit DownloadManager(Client&);
77
78     void startDownload(NetworkConnectionToWebProcess*, PAL::SessionID, DownloadID, const WebCore::ResourceRequest&, const String& suggestedName = { });
79     void dataTaskBecameDownloadTask(DownloadID, std::unique_ptr<Download>&&);
80     void continueWillSendRequest(DownloadID, WebCore::ResourceRequest&&);
81     void willDecidePendingDownloadDestination(NetworkDataTask&, ResponseCompletionHandler&&);
82     void convertNetworkLoadToDownload(DownloadID, std::unique_ptr<NetworkLoad>&&, ResponseCompletionHandler&&,  Vector<RefPtr<WebCore::BlobDataFileReference>>&&, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
83     void continueDecidePendingDownloadDestination(DownloadID, String destination, SandboxExtension::Handle&&, bool allowOverwrite);
84
85     void resumeDownload(PAL::SessionID, DownloadID, const IPC::DataReference& resumeData, const String& path, SandboxExtension::Handle&&);
86
87     void cancelDownload(DownloadID);
88 #if PLATFORM(COCOA)
89     void publishDownloadProgress(DownloadID, const URL&, SandboxExtension::Handle&&);
90 #endif
91     
92     Download* download(DownloadID downloadID) { return m_downloads.get(downloadID); }
93
94     void downloadFinished(Download*);
95     bool isDownloading() const { return !m_downloads.isEmpty(); }
96     uint64_t activeDownloadCount() const { return m_downloads.size(); }
97
98     void didCreateDownload();
99     void didDestroyDownload();
100
101     IPC::Connection* downloadProxyConnection();
102     AuthenticationManager& downloadsAuthenticationManager();
103
104 private:
105     Client& m_client;
106     HashMap<DownloadID, std::unique_ptr<PendingDownload>> m_pendingDownloads;
107     HashMap<DownloadID, std::pair<RefPtr<NetworkDataTask>, ResponseCompletionHandler>> m_downloadsWaitingForDestination;
108     HashMap<DownloadID, RefPtr<NetworkDataTask>> m_downloadsAfterDestinationDecided;
109     HashMap<DownloadID, std::unique_ptr<Download>> m_downloads;
110 };
111
112 } // namespace WebKit