[Curl] Improve multi-threaded networking
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlDownload.h
1 /*
2  * Copyright (C) 2013 Apple Inc.  All rights reserved.
3  * Copyright (C) 2017 Sony Interactive Entertainment Inc.
4  * Copyright (C) 2017 NAVER Corp.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #pragma once
29
30 #include "CurlJobManager.h"
31 #include "FileSystem.h"
32 #include "ResourceHandle.h"
33 #include "ResourceResponse.h"
34 #include <wtf/Lock.h>
35 #include <wtf/Threading.h>
36
37 namespace WebCore {
38
39 class CurlDownloadListener {
40 public:
41     virtual void didReceiveResponse() { }
42     virtual void didReceiveDataOfLength(int) { }
43     virtual void didFinish() { }
44     virtual void didFail() { }
45 };
46
47 class CurlDownload : public ThreadSafeRefCounted<CurlDownload> {
48 public:
49     CurlDownload();
50     ~CurlDownload();
51
52     void init(CurlDownloadListener*, const URL&);
53     void init(CurlDownloadListener*, ResourceHandle*, const ResourceRequest&, const ResourceResponse&);
54
55     void setListener(CurlDownloadListener* listener) { m_listener = listener; }
56
57     bool start();
58     bool cancel();
59
60     ResourceResponse getResponse() const;
61
62     bool deletesFileUponFailure() const { return m_deletesFileUponFailure; }
63     void setDeletesFileUponFailure(bool deletesFileUponFailure) { m_deletesFileUponFailure = deletesFileUponFailure; }
64
65     void setDestination(const String& destination) { m_destination = destination; }
66
67 private:
68     void setupRequest();
69
70     void closeFile();
71     void moveFileToDestination();
72     void writeDataToFile(const char* data, int size);
73
74     void addHeaders(const ResourceRequest&);
75
76     // Called on download thread.
77     void didReceiveHeader(const String& header);
78     void didReceiveData(void* data, int size);
79
80     // Called on main thread.
81     void didReceiveResponse();
82     void didReceiveDataOfLength(int size);
83     void didFinish();
84     void didFail();
85
86     static size_t writeCallback(char* ptr, size_t, size_t nmemb, void* data);
87     static size_t headerCallback(char* ptr, size_t, size_t nmemb, void* data);
88
89     CurlHandle m_curlHandle;
90     URL m_url;
91     CurlJobTicket m_job;
92     String m_tempPath;
93     String m_destination;
94     PlatformFileHandle m_tempHandle { invalidPlatformFileHandle };
95     URL m_responseUrl;
96     String m_responseMIMEType;
97     String m_responseTextEncodingName;
98     String m_httpHeaderFieldName;
99     String m_httpHeaderFieldValue;
100     bool m_deletesFileUponFailure { false };
101     mutable Lock m_mutex;
102     CurlDownloadListener* m_listener { nullptr };
103 };
104
105 }