87754511308ed05151cad7217feae094cf167aff
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlDownload.h
1 /*
2  * Copyright (C) 2013 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef CurlDownload_h
27 #define CurlDownload_h
28
29 #include "FileSystem.h"
30 #include "ResourceHandle.h"
31 #include "ResourceResponse.h"
32 #include <wtf/Threading.h>
33
34 #if PLATFORM(WIN)
35 #include <windows.h>
36 #include <winsock2.h>
37 #endif
38
39 #include <curl/curl.h>
40
41 namespace WebCore {
42
43 class CurlDownloadManager {
44 public:
45     CurlDownloadManager();
46     ~CurlDownloadManager();
47
48     bool add(CURL* curlHandle);
49     bool remove(CURL* curlHandle);
50
51     int getActiveDownloadCount() const;
52     int getPendingDownloadCount() const;
53
54 private:
55     void startThreadIfNeeded();
56     void stopThread();
57     void stopThreadIfIdle();
58
59     void updateHandleList();
60
61     CURLM* getMultiHandle() const { return m_curlMultiHandle; }
62
63     bool runThread() const { return m_runThread; }
64     void setRunThread(bool runThread) { m_runThread = runThread; }
65
66     bool addToCurl(CURL* curlHandle);
67     bool removeFromCurl(CURL* curlHandle);
68
69     static void downloadThread(void* data);
70
71     ThreadIdentifier m_threadId;
72     CURLM* m_curlMultiHandle;
73     Vector<CURL*> m_pendingHandleList;
74     Vector<CURL*> m_activeHandleList;
75     Vector<CURL*> m_removedHandleList;
76     mutable Lock m_mutex;
77     bool m_runThread;
78 };
79
80 class CurlDownloadListener {
81 public:
82     virtual void didReceiveResponse() { }
83     virtual void didReceiveDataOfLength(int size) { }
84     virtual void didFinish() { }
85     virtual void didFail() { }
86 };
87
88 class CurlDownload : public ThreadSafeRefCounted<CurlDownload> {
89 public:
90     CurlDownload();
91     ~CurlDownload();
92
93     void init(CurlDownloadListener*, const WebCore::URL&);
94     void init(CurlDownloadListener*, ResourceHandle*, const ResourceRequest&, const ResourceResponse&);
95
96     void setListener(CurlDownloadListener* listener) { m_listener = listener; }
97
98     bool start();
99     bool cancel();
100
101     String getTempPath() const;
102     String getUrl() const;
103     WebCore::ResourceResponse getResponse() const;
104
105     bool deletesFileUponFailure() const { return m_deletesFileUponFailure; }
106     void setDeletesFileUponFailure(bool deletesFileUponFailure) { m_deletesFileUponFailure = deletesFileUponFailure; }
107
108     void setDestination(const String& destination) { m_destination = destination; }
109
110 private:
111     void closeFile();
112     void moveFileToDestination();
113     void writeDataToFile(const char* data, int size);
114
115     void addHeaders(const ResourceRequest&);
116
117     // Called on download thread.
118     void didReceiveHeader(const String& header);
119     void didReceiveData(void* data, int size);
120
121     // Called on main thread.
122     void didReceiveResponse();
123     void didReceiveDataOfLength(int size);
124     void didFinish();
125     void didFail();
126
127     static size_t writeCallback(void* ptr, size_t, size_t nmemb, void* data);
128     static size_t headerCallback(char* ptr, size_t, size_t nmemb, void* data);
129
130     static void downloadFinishedCallback(CurlDownload*);
131     static void downloadFailedCallback(CurlDownload*);
132     static void receivedDataCallback(CurlDownload*, int size);
133     static void receivedResponseCallback(CurlDownload*);
134
135     CURL* m_curlHandle;
136     struct curl_slist* m_customHeaders;
137     char* m_url;
138     String m_tempPath;
139     String m_destination;
140     WebCore::PlatformFileHandle m_tempHandle;
141     WebCore::ResourceResponse m_response;
142     bool m_deletesFileUponFailure;
143     mutable Lock m_mutex;
144     CurlDownloadListener *m_listener;
145
146     static CurlDownloadManager m_downloadManager;
147
148     friend class CurlDownloadManager;
149 };
150
151 }
152
153 #endif